1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
7 SDESC[standard]= Flexible IPAM and DCIM tool with plugin support
8 HOMEPAGE= https://github.com/netbox-community/netbox/
9 CONTACT= Michael_Reim[kraileth@elderlinux.org]
12 SITES[main]= GITHUB/netbox-community:netbox:v3.4.7
13 DISTFILE[1]= generated:main
15 SPKGS[standard]= complete
20 OPTIONS_AVAILABLE= none
21 OPTIONS_STANDARD= none
23 RUN_DEPENDS= python-Django:single:python_default
24 python-Jinja2:single:python_default
25 python-Markdown:single:python_default
26 python-Pillow:single:python_default
27 python-PyYAML:single:python_default
28 python-bleach:single:python_default
29 python-chardet:single:python_default
30 python-django-cors-headers:single:python_default
31 python-django-debug-toolbar:single:python_default
32 python-django-filter:single:python_default
33 python-django-graphiql-debug-toolbar:single:python_default
34 python-django-mptt:single:python_default
35 python-django-pglocks:single:python_default
36 python-django-prometheus:single:python_default
37 python-django-redis:single:python_default
38 python-django-rich:single:python_default
39 python-django-rq:single:python_default
40 python-django-tables2:single:python_default
41 python-django-taggit:single:python_default
42 python-django-timezone-field:single:python_default
43 python-djangorestframework:single:python_default
44 python-drf-yasg:single:python_default
45 python-graphene-django:single:python_default
46 python-gunicorn:single:python_default
47 python-markdown-include:single:python_default
48 python-mkdocs-material:single:python_default
49 python-mkdocstrings:single:python_default
50 python-netaddr:single:python_default
51 python-psycopg2:single:python_default
52 python-sentry-sdk:single:python_default
53 python-social-auth-app-django:single:python_default
54 python-social-auth-core:single:python_default
55 python-svgwrite:single:python_default
56 python-tablib:single:python_default
57 python-tzdata:single:python_default
62 LICENSE= APACHE20:primary
63 LICENSE_TERMS= primary:{{WRKSRC}}/NOTICE
64 LICENSE_FILE= APACHE20:{{WRKSRC}}/LICENSE.txt
68 CPE_VENDOR= netbox_project
69 FPC_EQUIVALENT= net-mgmt/netbox
73 SUB_FILES= 850.netbox-housekeeping.sample
77 SUB_LIST= PYTHON_CMD={{PYTHON_CMD}}
78 PYTHON_VER={{PYTHON_VER}}
81 (cd ${WRKSRC}/netbox && \
82 for src in $$( ${FIND} . ! -name '*.bak' ) ; do \
83 DEST=${STAGEDIR}${PREFIX}/share/netbox/$${src#.} && \
84 if ${TEST} -d "$$src" ; then \
87 ${INSTALL_DATA} "$$src" "$$DEST" ; \
90 cd ${WRKSRC} && ${COPYTREE_SHARE} docs ${STAGEDIR}${PREFIX}/share/netbox/docs
91 ${INSTALL_DATA} ${WRKSRC}/mkdocs.yml ${STAGEDIR}${PREFIX}/share/netbox
92 ${MKDIR} -p ${STAGEDIR}${PREFIX}/share/examples/netbox/bsd
93 ${INSTALL_DATA} ${WRKSRC}/contrib/apache.conf ${STAGEDIR}${PREFIX}/share/examples/netbox
94 ${INSTALL_DATA} ${WRKSRC}/contrib/gunicorn.py ${STAGEDIR}${PREFIX}/share/examples/netbox
95 ${INSTALL_DATA} ${WRKSRC}/contrib/nginx.conf ${STAGEDIR}${PREFIX}/share/examples/netbox
96 ${INSTALL_DATA} ${WRKDIR}/850.netbox-housekeeping.sample ${STAGEDIR}${PREFIX}/share/examples/netbox/bsd
97 ${INSTALL_DATA} ${WRKDIR}/netbox_rq.sample ${STAGEDIR}${PREFIX}/share/examples/netbox/bsd
98 ${INSTALL_DATA} ${WRKDIR}/netboxrc.sample ${STAGEDIR}${PREFIX}/share/examples/netbox/bsd
100 [FILE:1511:descriptions/desc.primary]
101 NetBox is the leading solution for modeling and documenting modern
102 networks. By combining the traditional disciplines of IP address
103 management (IPAM) and datacenter infrastructure management (DCIM) with
104 powerful APIs and extensions, NetBox provides the ideal "source of truth"
105 to power network automation. Available as open source software under the
106 Apache 2.0 license, NetBox is employed by thousands of organizations
109 Myriad infrastructure components can be modeled in NetBox, including:
111 - Hierarchical regions, site groups, sites and locations
112 - Racks, devices, and device components
113 - Cables and wireless connections
114 - Power distribution- Data circuits and providers
115 - Virtual machines and clusters
116 - IP prefixes, ranges and addresses
117 - VRFs and route targets
119 - FHRP groups (VRRP, HSRP, etc.)
121 - VLANs and scoped VLAN groups
122 - Organizational tenants and contacts
124 In addition to its extensive built-in models and functionality, NetBox can
125 be customized and extended through the use of:
129 - Configuration contexts
130 - Custom model validation rules
134 - Conditional webhooks
136 - Single sign-on (SSO) authentication
138 - Detailed change logging
140 NetBox runs as a web application atop the Django Python framework with a
141 PostgreSQL database. It also features a complete REST API as well as a
142 GraphQL API for easy integrating with other tools and systems.
146 96345a77a9985e1dcd131341e0e4e7495b317bf920d040e28f894a88fc2590cb 7377904 netbox-community-netbox-3.4.7.tar.gz
149 [FILE:23383:manifests/plist.primary]
151 generate_secret_key.py
154 share/netbox/circuits/
163 share/netbox/circuits/api/
165 nested_serializers.py
169 share/netbox/circuits/forms/
175 share/netbox/circuits/graphql/
179 share/netbox/circuits/migrations/
181 0002_squashed_0029.py
182 0003_extend_tag_support.py
183 0004_rename_cable_peer.py
184 0032_provider_service_id.py
185 0033_standardize_id_fields.py
186 0034_created_datetimefield.py
187 0035_provider_asns.py
188 0036_circuit_termination_date_tags_custom_fields.py
189 0037_new_cabling_models.py
190 0038_cabling_cleanup.py
191 0039_unique_constraints.py
192 0040_provider_remove_deprecated_fields.py
193 0041_standardize_description_comments.py
195 share/netbox/circuits/models/
199 share/netbox/circuits/tables/
204 share/netbox/circuits/tests/
222 share/netbox/dcim/api/
225 nested_serializers.py
229 share/netbox/dcim/forms/
241 share/netbox/dcim/graphql/
247 share/netbox/dcim/management/__init__.py
248 share/netbox/dcim/management/commands/
251 share/netbox/dcim/migrations/
254 0003_squashed_0130.py
255 0131_consoleport_speed.py
258 0134_interface_wwn_bridge.py
259 0135_tenancy_extensions.py
260 0136_device_airflow.py
261 0137_relax_uniqueness_constraints.py
262 0138_extend_tag_support.py
263 0139_rename_cable_peer.py
266 0142_rename_128gfc_qsfp28.py
267 0143_remove_primary_for_related_name.py
268 0144_fix_cable_abs_length.py
269 0145_site_remove_deprecated_fields.py
271 0147_inventoryitemrole.py
272 0148_inventoryitem_component.py
273 0149_inventoryitem_templates.py
274 0150_interface_vrf.py
275 0151_interface_speed_duplex.py
276 0152_standardize_id_fields.py
277 0153_created_datetimefield.py
278 0154_half_height_rack_units.py
279 0155_interface_poe_mode_type.py
280 0156_location_status.py
281 0157_new_cabling_models.py
282 0158_populate_cable_terminations.py
283 0159_populate_cable_paths.py
284 0160_populate_cable_ends.py
285 0161_cabling_cleanup.py
286 0162_unique_constraints.py
287 0163_weight_fields.py
288 0164_rack_mounting_depth.py
289 0165_standardize_description_comments.py
290 0166_virtualdevicecontext.py
291 0167_module_status.py
293 share/netbox/dcim/models/
296 device_component_templates.py
303 share/netbox/dcim/svg/
307 share/netbox/dcim/tables/
318 share/netbox/dcim/tests/
325 test_natural_ordering.py
350 share/netbox/extras/api/
353 nested_serializers.py
357 share/netbox/extras/forms/
368 share/netbox/extras/graphql/
373 share/netbox/extras/management/__init__.py
374 share/netbox/extras/management/commands/
385 share/netbox/extras/migrations/
387 0002_squashed_0059.py
388 0060_customlink_button_class.py
389 0061_extras_change_logging.py
390 0062_clear_secrets_changelog.py
391 0063_webhook_conditions.py
392 0064_configrevision.py
393 0065_imageattachment_change_logging.py
394 0066_customfield_name_validation.py
395 0067_customfield_min_max_values.py
396 0068_configcontext_cluster_types.py
397 0069_custom_object_field.py
398 0070_customlink_enabled.py
399 0071_standardize_id_fields.py
400 0072_created_datetimefield.py
401 0073_journalentry_tags_custom_fields.py
402 0074_customfield_extensions.py
403 0075_configcontext_locations.py
404 0076_tag_slug_unicode.py
405 0077_customlink_extend_text_and_url.py
406 0078_unique_constraints.py
407 0079_scheduled_jobs.py
408 0080_customlink_content_types.py
409 0081_exporttemplate_content_types.py
414 share/netbox/extras/models/
423 share/netbox/extras/plugins/
430 share/netbox/extras/tables/
434 share/netbox/extras/templatetags/
439 share/netbox/extras/tests/
445 test_customvalidator.py
454 share/netbox/extras/tests/dummy_plugin/
466 share/netbox/extras/tests/dummy_plugin/api/
470 share/netbox/extras/tests/dummy_plugin/migrations/
490 share/netbox/ipam/api/
492 nested_serializers.py
496 share/netbox/ipam/forms/
503 share/netbox/ipam/graphql/
509 share/netbox/ipam/management/__init__.py
510 share/netbox/ipam/management/commands/
513 share/netbox/ipam/migrations/
515 0002_squashed_0046.py
516 0047_prefix_depth_children.py
517 0048_prefix_populate_depth_children.py
518 0049_prefix_mark_utilized.py
520 0051_extend_tag_support.py
523 0054_vlangroup_min_max_vids.py
524 0055_servicetemplate.py
525 0056_standardize_id_fields.py
526 0057_created_datetimefield.py
527 0058_ipaddress_nat_inside_nonunique.py
529 0060_alter_l2vpn_slug.py
530 0061_fhrpgroup_name.py
531 0062_unique_constraints.py
532 0063_standardize_description_comments.py
533 0064_clear_search_cache.py
535 share/netbox/ipam/models/
543 share/netbox/ipam/tables/
551 share/netbox/ipam/tests/
558 share/netbox/media/devicetype-images/.gitignore
559 share/netbox/media/image-attachments/.gitignore
564 configuration_example.py
565 configuration_testing.py
568 context_processors.py
579 share/netbox/netbox/api/
589 share/netbox/netbox/api/serializers/
595 share/netbox/netbox/api/viewsets/
598 share/netbox/netbox/config/
601 share/netbox/netbox/forms/
604 share/netbox/netbox/graphql/
612 share/netbox/netbox/models/
615 share/netbox/netbox/navigation/
618 share/netbox/netbox/search/
621 share/netbox/netbox/tables/
625 share/netbox/netbox/tests/
628 test_authentication.py
637 share/netbox/netbox/views/
641 share/netbox/netbox/views/generic/
649 share/netbox/project-static/
659 share/netbox/project-static/dist/
668 materialdesignicons-webfont-2ZY4X5WS.woff
669 materialdesignicons-webfont-DWVXV5L5.woff
670 materialdesignicons-webfont-EH3JD4GG.ttf
671 materialdesignicons-webfont-ER2MFQKM.woff2
672 materialdesignicons-webfont-KSYPMDN6.woff2
673 materialdesignicons-webfont-LWDVGUDX.eot
674 materialdesignicons-webfont-UHEFFMSX.eot
675 materialdesignicons-webfont-WM6M6ZHQ.ttf
685 share/netbox/project-static/docs/.info
686 share/netbox/project-static/img/
692 netbox_touch-icon-180.png
695 share/netbox/project-static/js/setmode.js
696 share/netbox/project-static/netbox-graphiql/
700 share/netbox/project-static/src/
716 share/netbox/project-static/src/buttons/
725 share/netbox/project-static/src/device/
729 share/netbox/project-static/src/forms/
735 share/netbox/project-static/src/select/
740 share/netbox/project-static/src/select/api/
745 share/netbox/project-static/src/state/index.ts
746 share/netbox/project-static/src/stores/
751 share/netbox/project-static/src/tables/
754 share/netbox/project-static/styles/
775 share/netbox/reports/__init__.py
776 share/netbox/scripts/__init__.py
777 share/netbox/templates/
787 share/netbox/templates/admin/index.html
788 share/netbox/templates/admin/extras/configrevision/restore.html
789 share/netbox/templates/base/
794 share/netbox/templates/circuits/
796 circuit_terminations_swap.html
797 circuittermination_edit.html
801 share/netbox/templates/circuits/inc/circuit_termination.html
802 share/netbox/templates/dcim/
807 component_create.html
808 connections_list.html
810 consoleport_delete.html
811 consoleserverport.html
812 consoleserverport_delete.html
817 devicebay_delete.html
818 devicebay_depopulate.html
819 devicebay_populate.html
824 interface_delete.html
827 inventoryitem_bulk_delete.html
828 inventoryitem_delete.html
829 inventoryitem_edit.html
830 inventoryitemrole.html
839 poweroutlet_delete.html
842 powerport_delete.html
845 rack_elevation_list.html
854 virtualchassis_add.html
855 virtualchassis_add_member.html
856 virtualchassis_edit.html
857 virtualchassis_remove_member.html
858 virtualdevicecontext.html
859 share/netbox/templates/dcim/device/
863 consoleserverports.html
874 share/netbox/templates/dcim/device/inc/interface_table_controls.html
875 share/netbox/templates/dcim/devicerole/
877 virtual_machines.html
878 share/netbox/templates/dcim/devicetype/
880 component_templates.html
881 share/netbox/templates/dcim/inc/
882 cable_termination.html
883 cable_toggle_buttons.html
884 connection_endpoints.html
885 endpoint_connection.html
886 interface_vlans_table.html
887 nonracked_devices.html
889 share/netbox/templates/dcim/inc/panels/inventory_items.html
890 share/netbox/templates/dcim/moduletype/
892 component_templates.html
893 share/netbox/templates/dcim/trace/
901 share/netbox/templates/exceptions/
903 permission_error.html
904 programming_error.html
905 share/netbox/templates/extras/
910 imageattachment_edit.html
912 object_changelog.html
913 object_configcontext.html
916 objectchange_list.html
926 share/netbox/templates/extras/admin/plugins_list.html
927 share/netbox/templates/extras/htmx/
930 share/netbox/templates/extras/inc/
931 configcontext_data.html
932 configcontext_format.html
935 share/netbox/templates/extras/templatetags/log_level.html
936 share/netbox/templates/generic/
937 bulk_add_component.html
943 confirmation_form.html
948 share/netbox/templates/htmx/
951 share/netbox/templates/inc/
955 missing_prerequisites.html
962 table_controls_htmx.html
964 share/netbox/templates/inc/panels/
968 image_attachments.html
971 share/netbox/templates/ipam/
976 fhrpgroupassignment_edit.html
978 ipaddress_assign.html
979 ipaddress_bulk_add.html
983 l2vpntermination.html
984 l2vpntermination_edit.html
998 share/netbox/templates/ipam/aggregate/
1001 share/netbox/templates/ipam/inc/
1002 ipaddress_edit_header.html
1003 toggle_available.html
1004 share/netbox/templates/ipam/inc/panels/fhrp_groups.html
1005 share/netbox/templates/ipam/iprange/
1008 share/netbox/templates/ipam/prefix/
1013 share/netbox/templates/ipam/vlan/
1017 share/netbox/templates/rest_framework/api.html
1018 share/netbox/templates/tenancy/
1020 contactassignment_edit.html
1025 share/netbox/templates/users/
1032 share/netbox/templates/virtualization/
1034 cluster_add_devices.html
1038 virtualmachine_list.html
1040 share/netbox/templates/virtualization/cluster/
1043 virtual_machines.html
1044 share/netbox/templates/virtualization/virtualmachine/
1047 share/netbox/templates/wireless/
1049 wirelesslangroup.html
1051 wirelesslink_edit.html
1052 share/netbox/templates/wireless/inc/
1053 authentication_attrs.html
1054 wirelesslink_interface.html
1055 share/netbox/tenancy/
1063 share/netbox/tenancy/api/
1065 nested_serializers.py
1069 share/netbox/tenancy/forms/
1076 share/netbox/tenancy/graphql/
1080 share/netbox/tenancy/migrations/
1081 0001_squashed_0012.py
1082 0002_tenant_ordering.py
1084 0004_extend_tag_support.py
1085 0005_standardize_id_fields.py
1086 0006_created_datetimefield.py
1087 0007_contact_link.py
1088 0008_unique_constraints.py
1089 0009_standardize_description_comments.py
1091 share/netbox/tenancy/models/
1095 share/netbox/tenancy/tables/
1100 share/netbox/tenancy/tests/
1118 share/netbox/users/admin/
1123 share/netbox/users/api/
1125 nested_serializers.py
1129 share/netbox/users/graphql/
1133 share/netbox/users/migrations/
1134 0001_squashed_0011.py
1135 0002_standardize_id_fields.py
1136 0003_token_allowed_ips_last_used.py
1138 share/netbox/users/tests/
1144 share/netbox/utilities/
1149 custom_inspectors.py
1169 share/netbox/utilities/forms/
1175 share/netbox/utilities/forms/fields/
1182 share/netbox/utilities/management/__init__.py
1183 share/netbox/utilities/management/commands/
1187 share/netbox/utilities/serializers/json.py
1188 share/netbox/utilities/templates/builtins/
1191 customfield_value.html
1193 share/netbox/utilities/templates/buttons/
1202 share/netbox/utilities/templates/form_helpers/
1203 render_custom_fields.html
1207 share/netbox/utilities/templates/helpers/
1208 applied_filters.html
1209 table_config_form.html
1210 utilization_graph.html
1211 share/netbox/utilities/templates/navigation/menu.html
1212 share/netbox/utilities/templates/tabs/model_view_tabs.html
1213 share/netbox/utilities/templates/widgets/
1214 clearable_file_input.html
1215 colorselect_option.html
1217 select_duration.html
1219 select_option_with_pk.html
1222 share/netbox/utilities/templatetags/
1230 share/netbox/utilities/templatetags/builtins/
1234 share/netbox/utilities/testing/
1241 share/netbox/utilities/tests/
1250 share/netbox/virtualization/
1258 share/netbox/virtualization/api/
1260 nested_serializers.py
1264 share/netbox/virtualization/forms/
1272 share/netbox/virtualization/graphql/
1276 share/netbox/virtualization/migrations/
1277 0001_squashed_0022.py
1278 0023_virtualmachine_natural_ordering.py
1279 0024_cluster_relax_uniqueness.py
1280 0025_extend_tag_support.py
1281 0026_vminterface_bridge.py
1282 0027_standardize_id_fields.py
1283 0028_vminterface_vrf.py
1284 0029_created_datetimefield.py
1285 0030_cluster_status.py
1286 0031_virtualmachine_site_device.py
1287 0032_virtualmachine_update_sites.py
1288 0033_unique_constraints.py
1289 0034_standardize_description_comments.py
1291 share/netbox/virtualization/models/
1295 share/netbox/virtualization/tables/
1299 share/netbox/virtualization/tests/
1305 share/netbox/wireless/
1317 share/netbox/wireless/api/
1319 nested_serializers.py
1323 share/netbox/wireless/forms/
1329 share/netbox/wireless/graphql/
1333 share/netbox/wireless/migrations/
1335 0002_standardize_id_fields.py
1336 0003_created_datetimefield.py
1337 0004_wireless_tenancy.py
1338 0005_wirelesslink_interface_types.py
1339 0006_unique_constraints.py
1340 0007_standardize_description_comments.py
1341 0008_wirelesslan_status.py
1343 share/netbox/wireless/tables/
1347 share/netbox/wireless/tests/
1354 [FILE:4976:manifests/plist.docs]
1355 share/netbox/docs/docs/
1361 share/netbox/docs/docs/_theme/main.html
1362 share/netbox/docs/docs/administration/
1367 replicating-netbox.md
1368 share/netbox/docs/docs/administration/authentication/
1369 microsoft-azure-ad.md
1372 share/netbox/docs/docs/configuration/
1382 remote-authentication.md
1383 required-parameters.md
1386 share/netbox/docs/docs/customization/
1390 custom-validation.md
1393 share/netbox/docs/docs/development/
1395 application-registry.md
1401 release-checklist.md
1407 share/netbox/docs/docs/features/
1409 authentication-permissions.md
1426 share/netbox/docs/docs/getting-started/
1429 share/netbox/docs/docs/installation/
1438 share/netbox/docs/docs/integrations/
1441 prometheus-metrics.md
1444 share/netbox/docs/docs/media/
1445 admin_ui_run_permission.png
1446 power_distribution.png
1447 share/netbox/docs/docs/media/authentication/
1448 azure_ad_add_app_registration.png
1449 azure_ad_add_client_secret.png
1450 azure_ad_app_registration.png
1451 azure_ad_app_registration_created.png
1452 azure_ad_client_secret.png
1453 azure_ad_client_secret_created.png
1454 azure_ad_login_portal.png
1455 netbox_azure_ad_login.png
1456 netbox_okta_login.png
1457 okta_create_app_registration.png
1458 okta_integration_parameters.png
1459 okta_login_portal.png
1460 okta_web_app_integration.png
1461 share/netbox/docs/docs/media/development/
1463 github_fork_button.png
1464 github_fork_dialog.png
1465 github_new_issue.png
1466 share/netbox/docs/docs/media/installation/
1467 netbox_application_stack.png
1469 share/netbox/docs/docs/media/models/dcim_cable_trace.png
1470 share/netbox/docs/docs/media/release-notes/netbox30_ui.png
1471 share/netbox/docs/docs/media/screenshots/
1477 share/netbox/docs/docs/models/circuits/
1479 circuittermination.md
1483 share/netbox/docs/docs/models/dcim/
1486 consoleporttemplate.md
1487 consoleserverport.md
1488 consoleserverporttemplate.md
1491 devicebaytemplate.md
1495 frontporttemplate.md
1497 interfacetemplate.md
1499 inventoryitemrole.md
1500 inventoryitemtemplate.md
1505 modulebaytemplate.md
1510 poweroutlettemplate.md
1513 powerporttemplate.md
1523 virtualdevicecontext.md
1524 share/netbox/docs/docs/models/extras/
1536 share/netbox/docs/docs/models/ipam/
1540 fhrpgroupassignment.md
1554 share/netbox/docs/docs/models/tenancy/
1560 share/netbox/docs/docs/models/virtualization/
1566 share/netbox/docs/docs/models/wireless/
1570 share/netbox/docs/docs/plugins/index.md
1571 share/netbox/docs/docs/plugins/development/
1586 share/netbox/docs/docs/reference/
1590 share/netbox/docs/docs/release-notes/
1611 [FILE:155:manifests/plist.examples]
1612 share/examples/netbox/
1616 share/examples/netbox/bsd/
1617 850.netbox-housekeeping.sample
1622 [FILE:578:patches/patch-mkdocs.yml]
1623 --- mkdocs.yml.orig 2023-03-28 18:08:04 UTC
1626 site_name: NetBox Documentation
1627 -site_dir: netbox/project-static/docs
1628 +site_dir: project-static/docs
1629 site_url: https://docs.netbox.dev/
1630 repo_name: netbox-community/netbox
1631 repo_url: https://github.com/netbox-community/netbox
1632 @@ -27,7 +27,6 @@ plugins:
1636 - - os.chdir('netbox/')
1637 - os.environ.setdefault("DJANGO_SETTINGS_MODULE", "netbox.settings")
1642 [FILE:789:files/850.netbox-housekeeping.sample.in]
1644 # This shell script invokes NetBox's housekeeping management command, which
1645 # intended to be run nightly.
1647 # If you want to enable this script, copy it to %%PREFIX%%/etc/periodic/daily
1648 # and place the following into /etc/periodic.conf:
1650 # daily_netbox_housekeeping_enable="YES"
1652 # If NetBox has been installed into a nonstandard location, update the paths
1654 command="%%PYTHON_CMD%%"
1655 netbox_root="%%PREFIX%%/share/netbox"
1657 # If there is a global system configuration file, suck it in.
1659 if [ -r /etc/defaults/periodic.conf ]; then
1660 . /etc/defaults/periodic.conf
1661 source_periodic_confs
1666 case "$daily_netbox_housekeeping_enable" in
1669 echo "Running NetBox housekeeping:"
1670 $command "$netbox_root/manage.py" housekeeping
1677 [FILE:934:files/netbox_rq.sample.in]
1680 # This sample rc script starts the RQ worker background service which is
1681 # required for Webhooks and various automation tasks.
1684 # PROVIDE: netbox_rq
1688 # Add the following line to /etc/rc.conf.local or /etc/rc.conf
1689 # to enable netbox-rq:
1691 # netbox_rq_enable (bool): Set to NO by default.
1692 # Set it to YES to enable netbox_rq.
1697 rcvar=netbox_rq_enable
1699 load_rc_config $name
1701 start_cmd="netbox_rq_start"
1702 start_precmd="netbox_rq_precmd"
1703 command="%%PYTHON_CMD%%"
1704 command_args="%%PREFIX%%/share/netbox/manage.py rqworker"
1705 pidfile=${netbox_rq_pidfile:-/var/run/${name}/${name}.pid}
1706 netbox_rq_user=${netbox_rq_user:-www}
1711 install -d -o ${netbox_rq_user} `dirname ${pidfile}`
1716 echo "Starting netbox_rq."
1717 /usr/sbin/daemon -cf -p ${pidfile} -u ${netbox_rq_user} ${command} ${command_args}
1723 [FILE:3721:files/netboxrc.sample.in]
1726 # This sample rc script eliminate the need to use sysutils/py-supervisor to
1727 # run NetBox as a system service. Only www/py-gunicorn is needed as a WSGI.
1729 # Of course a working HTTP server like Apache/nginx is still required to make
1730 # use of the gunicorn WSGI.
1737 # Add the following line to /etc/rc.conf.local or /etc/rc.conf
1740 # netbox_enable (bool): Set to NO by default.
1741 # Set it to YES to enable netbox.
1742 # netbox_use_config (bool): Set to NO by default.
1743 # If set, read the configuration parameter from file defined in
1744 # "netbox_config" instead using rc variables.
1745 # netbox_config (str): Default to "/usr/local/etc/${name}.conf}"
1746 # Config file for gunicorn's netbox config file
1747 # netbox_command (str): Default to "%%LOCALBASE%%/bin/gunicorn"
1748 # Path to gunicorn to run netbox
1749 # netbox_bind (str): Default to "localhost:8001"
1750 # Interface and port to bind to
1751 # netbox_workers (int): Default to "5"
1752 # Number of gunicorn workers
1753 # netbox_threads (int): Default to "3"
1754 # Number of worker threads per handling request
1755 # netbox_timeout (int): Default to "120"
1756 # Worker timeout for gunicorn
1757 # netbox_max_requests (int): Default to "5000"
1758 # Maximum number of requests a worker process will process before respawning
1759 # netbox_max_requests_jitter (int): Default to "500"
1760 # Maximum number jitter to add to "netbox_max_requests"
1761 # netbox_extra_args (str): Not set by default
1762 # Extra arguments that are passed to gunicorn
1769 netbox_path=%%PREFIX%%/share/netbox
1770 extra_commands="upgrade"
1772 load_rc_config $name
1774 start_precmd="netbox_precmd"
1775 upgrade_cmd="netbox_upgrade"
1776 command=${netbox_program:-%%LOCALBASE%%/bin/gunicorn}
1777 procname=${netbox_procname:-%%PYTHON_CMD%%}
1778 netbox_chdir=${netbox_path}
1779 pidfile=${netbox_pidfile:-/var/run/${name}/${name}.pid}
1780 netbox_user=${netbox_user:-wwwraven}
1781 netbox_use_config=${netbox_use_config:-no}
1782 netbox_config=${netbox_config:-/${name}.conf}
1783 netbox_bind=${netbox_bind:-localhost:8001}
1784 netbox_workers=${netbox_workers:-5}
1785 netbox_threads=${netbox_threads:-3}
1786 netbox_timeout=${netbox_timeout:-120}
1787 netbox_max_requests=${netbox_max_requests:-5000}
1788 netbox_max_requests_jitter=${netbox_max_requests_jitter:-500}
1790 # Read settings from confguration file if set
1791 if checkyesno netbox_use_config && [ -f "${netbox_config}" ]; then
1792 command_args="${netbox_args} -D \
1793 --log-syslog --log-syslog-prefix ${name} \
1794 --log-syslog-to unix:///var/run/log#dgram \
1795 --disable-redirect-access-to-syslog \
1796 -p ${pidfile} --pythonpath ${netbox_path} \
1797 -c ${netbox_config} \
1800 command_args="${netbox_args} -D \
1801 --log-syslog --log-syslog-prefix ${name} \
1802 --log-syslog-to unix:///var/run/log#dgram \
1803 --disable-redirect-access-to-syslog \
1804 -p ${pidfile} --pythonpath ${netbox_path} \
1805 -b ${netbox_bind} -w ${netbox_workers} --threads ${netbox_threads} -t ${netbox_timeout} \
1806 --max-requests ${netbox_max_requests} --max-requests-jitter ${netbox_max_requests_jitter} \
1807 ${netbox_extra_args} \
1813 install -d -o ${netbox_user} `dirname ${pidfile}`
1818 if [ -f ${pidfile} ]; then
1820 %%PYTHON_CMD%% manage.py migrate
1821 %%PYTHON_CMD%% manage.py trace_paths --no-input
1822 %%LOCALBASE%%/bin/mkdocs build
1823 %%PYTHON_CMD%% manage.py collectstatic --no-input
1824 %%PYTHON_CMD%% manage.py remove_stale_contenttypes --no-input
1825 %%PYTHON_CMD%% manage.py clearsessions
1826 %%PYTHON_CMD%% manage.py clearcache
1827 echo "Please restart NetBox and the WSGI environment."
1829 echo "NetBox is not running!"
1836 [FILE:1152:files/pkg-message-primary.in]
1837 Please note that NetBox requires a PostgreSQL database server, which uses its
1838 built-in network address datatypes. Thus NetBox won't work with other RDBMS's,
1839 e.g. MySQL, MariaDB, etc.
1841 For installation instructions please refer to the related wiki page:
1843 - https://wiki.freebsd.org/Ports/net-mgmt/netbox
1849 As always it is strongly encouraged to make a backup of the database before the
1850 database migrations will be executed.
1852 The following steps are required to finish the upgrade:
1854 1. Run database migrations, trace any missing cable paths, build the embedded
1855 documentation, collect static files, remove stale content files, delete any
1856 expired user sessions and clear the cache.
1858 # cd %%PREXIX%%/share/netbox
1859 # python%%PYTHON_VER%% manage.py migrate
1860 # python%%PYTHON_VER%% manage.py trace_paths --no-input
1862 # python%%PYTHON_VER%% manage.py collectstatic --no-input
1863 # python%%PYTHON_VER%% manage.py remove_stale_contenttypes --no-input
1864 # python%%PYTHON_VER%% manage.py clearsessions
1865 # python%%PYTHON_VER%% manage.py clearcache
1867 2. Restart WSGI/httpd environment (supervisord/apache/nginx/etc.)