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.5.2
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 2bb44f926a72b7e9c10655269974b7c76fa44365b69fd7eddd9d40a33508150f 5732695 netbox-community-netbox-3.5.2.tar.gz
149 [FILE:25518: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
194 0042_provideraccount.py
196 share/netbox/circuits/models/
200 share/netbox/circuits/tables/
205 share/netbox/circuits/tests/
222 share/netbox/core/api/
224 nested_serializers.py
229 share/netbox/core/forms/
236 share/netbox/core/graphql/
240 share/netbox/core/management/__init__.py
241 share/netbox/core/management/commands/
249 share/netbox/core/migrations/
253 0004_replicate_jobresults.py
254 0005_job_created_auto_now.py
256 share/netbox/core/models/
261 share/netbox/core/tables/
265 share/netbox/core/tests/
283 share/netbox/dcim/api/
286 nested_serializers.py
290 share/netbox/dcim/forms/
302 share/netbox/dcim/graphql/
308 share/netbox/dcim/management/__init__.py
309 share/netbox/dcim/management/commands/
312 share/netbox/dcim/migrations/
315 0003_squashed_0130.py
316 0131_consoleport_speed.py
319 0134_interface_wwn_bridge.py
320 0135_tenancy_extensions.py
321 0136_device_airflow.py
322 0137_relax_uniqueness_constraints.py
323 0138_extend_tag_support.py
324 0139_rename_cable_peer.py
327 0142_rename_128gfc_qsfp28.py
328 0143_remove_primary_for_related_name.py
329 0144_fix_cable_abs_length.py
330 0145_site_remove_deprecated_fields.py
332 0147_inventoryitemrole.py
333 0148_inventoryitem_component.py
334 0149_inventoryitem_templates.py
335 0150_interface_vrf.py
336 0151_interface_speed_duplex.py
337 0152_standardize_id_fields.py
338 0153_created_datetimefield.py
339 0154_half_height_rack_units.py
340 0155_interface_poe_mode_type.py
341 0156_location_status.py
342 0157_new_cabling_models.py
343 0158_populate_cable_terminations.py
344 0159_populate_cable_paths.py
345 0160_populate_cable_ends.py
346 0161_cabling_cleanup.py
347 0162_unique_constraints.py
348 0163_weight_fields.py
349 0164_rack_mounting_depth.py
350 0165_standardize_description_comments.py
351 0166_virtualdevicecontext.py
352 0167_module_status.py
353 0168_interface_template_enabled.py
354 0169_devicetype_default_platform.py
355 0170_configtemplate.py
356 0171_cabletermination_change_logging.py
358 share/netbox/dcim/models/
361 device_component_templates.py
368 share/netbox/dcim/svg/
372 share/netbox/dcim/tables/
383 share/netbox/dcim/tests/
390 test_natural_ordering.py
415 share/netbox/extras/api/
419 nested_serializers.py
423 share/netbox/extras/dashboard/
428 share/netbox/extras/forms/
439 share/netbox/extras/graphql/
444 share/netbox/extras/management/__init__.py
445 share/netbox/extras/management/commands/
453 share/netbox/extras/migrations/
455 0002_squashed_0059.py
456 0060_customlink_button_class.py
457 0061_extras_change_logging.py
458 0062_clear_secrets_changelog.py
459 0063_webhook_conditions.py
460 0064_configrevision.py
461 0065_imageattachment_change_logging.py
462 0066_customfield_name_validation.py
463 0067_customfield_min_max_values.py
464 0068_configcontext_cluster_types.py
465 0069_custom_object_field.py
466 0070_customlink_enabled.py
467 0071_standardize_id_fields.py
468 0072_created_datetimefield.py
469 0073_journalentry_tags_custom_fields.py
470 0074_customfield_extensions.py
471 0075_configcontext_locations.py
472 0076_tag_slug_unicode.py
473 0077_customlink_extend_text_and_url.py
474 0078_unique_constraints.py
475 0079_scheduled_jobs.py
476 0080_customlink_content_types.py
477 0081_exporttemplate_content_types.py
482 0086_configtemplate.py
484 0088_jobresult_webhooks.py
485 0089_customfield_is_cloneable.py
486 0090_objectchange_index_request_id.py
487 0091_create_managedfiles.py
488 0092_delete_jobresult.py
490 share/netbox/extras/models/
503 share/netbox/extras/plugins/
510 share/netbox/extras/tables/
514 share/netbox/extras/templatetags/
520 share/netbox/extras/tests/
526 test_customvalidator.py
535 share/netbox/extras/tests/dummy_plugin/
547 share/netbox/extras/tests/dummy_plugin/api/
551 share/netbox/extras/tests/dummy_plugin/migrations/
571 share/netbox/ipam/api/
574 nested_serializers.py
578 share/netbox/ipam/forms/
585 share/netbox/ipam/graphql/
591 share/netbox/ipam/management/__init__.py
592 share/netbox/ipam/management/commands/
595 share/netbox/ipam/migrations/
597 0002_squashed_0046.py
598 0047_prefix_depth_children.py
599 0048_prefix_populate_depth_children.py
600 0049_prefix_mark_utilized.py
602 0051_extend_tag_support.py
605 0054_vlangroup_min_max_vids.py
606 0055_servicetemplate.py
607 0056_standardize_id_fields.py
608 0057_created_datetimefield.py
609 0058_ipaddress_nat_inside_nonunique.py
611 0060_alter_l2vpn_slug.py
612 0061_fhrpgroup_name.py
613 0062_unique_constraints.py
614 0063_standardize_description_comments.py
615 0064_clear_search_cache.py
617 0066_iprange_mark_utilized.py
619 share/netbox/ipam/models/
628 share/netbox/ipam/tables/
637 share/netbox/ipam/tests/
644 share/netbox/media/devicetype-images/.gitignore
645 share/netbox/media/image-attachments/.gitignore
650 configuration_example.py
651 configuration_testing.py
654 context_processors.py
665 share/netbox/netbox/api/
676 share/netbox/netbox/api/serializers/
682 share/netbox/netbox/api/viewsets/
685 share/netbox/netbox/config/
688 share/netbox/netbox/forms/
691 share/netbox/netbox/graphql/
699 share/netbox/netbox/models/
702 share/netbox/netbox/navigation/
705 share/netbox/netbox/search/
708 share/netbox/netbox/tables/
712 share/netbox/netbox/tests/
715 test_authentication.py
724 share/netbox/netbox/views/
729 share/netbox/netbox/views/generic/
737 share/netbox/project-static/
747 share/netbox/project-static/dist/
752 materialdesignicons-webfont-DWVXV5L5.woff
753 materialdesignicons-webfont-ER2MFQKM.woff2
754 materialdesignicons-webfont-UHEFFMSX.eot
755 materialdesignicons-webfont-WM6M6ZHQ.ttf
763 share/netbox/project-static/docs/.info
764 share/netbox/project-static/img/
770 netbox_touch-icon-180.png
773 share/netbox/project-static/js/setmode.js
774 share/netbox/project-static/netbox-graphiql/
778 share/netbox/project-static/src/
796 share/netbox/project-static/src/buttons/
806 share/netbox/project-static/src/forms/
811 share/netbox/project-static/src/select/
816 share/netbox/project-static/src/select/api/
821 share/netbox/project-static/src/state/index.ts
822 share/netbox/project-static/src/stores/
828 share/netbox/project-static/src/tables/
831 share/netbox/project-static/styles/
852 share/netbox/reports/__init__.py
853 share/netbox/scripts/__init__.py
854 share/netbox/templates/
863 share/netbox/templates/admin/index.html
864 share/netbox/templates/admin/extras/configrevision/restore.html
865 share/netbox/templates/base/
870 share/netbox/templates/circuits/
872 circuit_terminations_swap.html
873 circuittermination_edit.html
878 share/netbox/templates/circuits/inc/circuit_termination.html
879 share/netbox/templates/core/
884 share/netbox/templates/dcim/
889 component_create.html
890 connections_list.html
892 consoleport_delete.html
893 consoleserverport.html
894 consoleserverport_delete.html
899 devicebay_delete.html
900 devicebay_depopulate.html
901 devicebay_populate.html
906 interface_delete.html
908 inventoryitem_bulk_delete.html
909 inventoryitem_delete.html
910 inventoryitem_edit.html
911 inventoryitemrole.html
920 poweroutlet_delete.html
923 powerport_delete.html
926 rack_elevation_list.html
935 virtualchassis_add.html
936 virtualchassis_add_member.html
937 virtualchassis_edit.html
938 virtualchassis_remove_member.html
939 virtualdevicecontext.html
940 share/netbox/templates/dcim/device/
943 consoleserverports.html
953 share/netbox/templates/dcim/device/inc/interface_table_controls.html
954 share/netbox/templates/dcim/devicetype/
956 component_templates.html
957 share/netbox/templates/dcim/inc/
958 cable_termination.html
959 cable_toggle_buttons.html
960 connection_endpoints.html
961 endpoint_connection.html
962 interface_vlans_table.html
963 nonracked_devices.html
965 share/netbox/templates/dcim/inc/panels/inventory_items.html
966 share/netbox/templates/dcim/moduletype/
968 component_templates.html
969 share/netbox/templates/dcim/rack/
972 share/netbox/templates/dcim/trace/
980 share/netbox/templates/exceptions/
982 permission_error.html
983 programming_error.html
984 share/netbox/templates/extras/
986 configcontext_list.html
988 configtemplate_list.html
992 exporttemplate_list.html
993 imageattachment_edit.html
995 object_changelog.html
996 object_configcontext.html
999 objectchange_list.html
1009 share/netbox/templates/extras/admin/plugins_list.html
1010 share/netbox/templates/extras/dashboard/
1015 share/netbox/templates/extras/dashboard/widgets/
1019 share/netbox/templates/extras/htmx/
1022 share/netbox/templates/extras/inc/
1023 configcontext_data.html
1024 configcontext_format.html
1026 share/netbox/templates/extras/report/
1030 share/netbox/templates/extras/script/
1034 share/netbox/templates/extras/templatetags/log_level.html
1035 share/netbox/templates/generic/
1036 bulk_add_component.html
1042 confirmation_form.html
1047 share/netbox/templates/htmx/
1050 object_selector.html
1051 object_selector_results.html
1053 share/netbox/templates/inc/
1057 missing_prerequisites.html
1065 table_controls_htmx.html
1067 share/netbox/templates/inc/panels/
1070 image_attachments.html
1071 related_objects.html
1073 share/netbox/templates/ipam/
1078 fhrpgroupassignment_edit.html
1080 ipaddress_assign.html
1081 ipaddress_bulk_add.html
1085 l2vpntermination.html
1086 l2vpntermination_edit.html
1095 servicetemplate.html
1100 share/netbox/templates/ipam/aggregate/
1103 share/netbox/templates/ipam/asnrange/
1106 share/netbox/templates/ipam/inc/
1107 ipaddress_edit_header.html
1108 toggle_available.html
1109 share/netbox/templates/ipam/inc/panels/fhrp_groups.html
1110 share/netbox/templates/ipam/iprange/
1113 share/netbox/templates/ipam/prefix/
1118 share/netbox/templates/ipam/vlan/
1122 share/netbox/templates/rest_framework/api.html
1123 share/netbox/templates/tenancy/
1125 contactassignment_edit.html
1130 share/netbox/templates/users/
1137 share/netbox/templates/virtualization/
1139 cluster_add_devices.html
1143 virtualmachine_list.html
1145 share/netbox/templates/virtualization/cluster/
1148 virtual_machines.html
1149 share/netbox/templates/virtualization/virtualmachine/
1152 share/netbox/templates/wireless/
1154 wirelesslangroup.html
1156 share/netbox/templates/wireless/inc/
1157 authentication_attrs.html
1158 wirelesslink_interface.html
1159 share/netbox/tenancy/
1167 share/netbox/tenancy/api/
1169 nested_serializers.py
1173 share/netbox/tenancy/forms/
1180 share/netbox/tenancy/graphql/
1184 share/netbox/tenancy/migrations/
1185 0001_squashed_0012.py
1186 0002_tenant_ordering.py
1188 0004_extend_tag_support.py
1189 0005_standardize_id_fields.py
1190 0006_created_datetimefield.py
1191 0007_contact_link.py
1192 0008_unique_constraints.py
1193 0009_standardize_description_comments.py
1194 0010_tenant_relax_uniqueness.py
1196 share/netbox/tenancy/models/
1200 share/netbox/tenancy/tables/
1205 share/netbox/tenancy/tests/
1223 share/netbox/users/admin/
1228 share/netbox/users/api/
1230 nested_serializers.py
1234 share/netbox/users/graphql/
1238 share/netbox/users/migrations/
1239 0001_squashed_0011.py
1240 0002_standardize_id_fields.py
1241 0003_token_allowed_ips_last_used.py
1243 share/netbox/users/tests/
1249 share/netbox/utilities/
1259 graphql_optimizer.py
1278 share/netbox/utilities/forms/
1285 share/netbox/utilities/forms/fields/
1293 share/netbox/utilities/forms/widgets/
1299 share/netbox/utilities/serializers/json.py
1300 share/netbox/utilities/templates/builtins/
1303 customfield_value.html
1305 share/netbox/utilities/templates/buttons/
1315 share/netbox/utilities/templates/form_helpers/
1316 render_custom_fields.html
1320 share/netbox/utilities/templates/helpers/
1321 applied_filters.html
1322 table_config_form.html
1323 utilization_graph.html
1324 share/netbox/utilities/templates/navigation/menu.html
1325 share/netbox/utilities/templates/tabs/model_view_tabs.html
1326 share/netbox/utilities/templates/widgets/
1328 clearable_file_input.html
1329 colorselect_option.html
1331 number_with_options.html
1333 select_option_with_pk.html
1335 share/netbox/utilities/templatetags/
1343 share/netbox/utilities/templatetags/builtins/
1347 share/netbox/utilities/testing/
1354 share/netbox/utilities/tests/
1363 share/netbox/virtualization/
1371 share/netbox/virtualization/api/
1373 nested_serializers.py
1377 share/netbox/virtualization/forms/
1385 share/netbox/virtualization/graphql/
1389 share/netbox/virtualization/migrations/
1390 0001_squashed_0022.py
1391 0023_virtualmachine_natural_ordering.py
1392 0024_cluster_relax_uniqueness.py
1393 0025_extend_tag_support.py
1394 0026_vminterface_bridge.py
1395 0027_standardize_id_fields.py
1396 0028_vminterface_vrf.py
1397 0029_created_datetimefield.py
1398 0030_cluster_status.py
1399 0031_virtualmachine_site_device.py
1400 0032_virtualmachine_update_sites.py
1401 0033_unique_constraints.py
1402 0034_standardize_description_comments.py
1404 share/netbox/virtualization/models/
1408 share/netbox/virtualization/tables/
1412 share/netbox/virtualization/tests/
1418 share/netbox/wireless/
1430 share/netbox/wireless/api/
1432 nested_serializers.py
1436 share/netbox/wireless/forms/
1442 share/netbox/wireless/graphql/
1446 share/netbox/wireless/migrations/
1448 0002_standardize_id_fields.py
1449 0003_created_datetimefield.py
1450 0004_wireless_tenancy.py
1451 0005_wirelesslink_interface_types.py
1452 0006_unique_constraints.py
1453 0007_standardize_description_comments.py
1454 0008_wirelesslan_status.py
1456 share/netbox/wireless/tables/
1460 share/netbox/wireless/tests/
1465 share/netbox/templates/tenancy/
1466 object_contacts.html
1467 share/netbox/templates/ipam/ipaddress/
1470 share/netbox/dcim/migrations/
1471 0172_larger_power_draw_values.py
1474 [FILE:5239:manifests/plist.docs]
1475 share/netbox/docs/docs/
1481 share/netbox/docs/docs/_theme/main.html
1482 share/netbox/docs/docs/administration/
1487 replicating-netbox.md
1488 share/netbox/docs/docs/administration/authentication/
1489 microsoft-azure-ad.md
1492 share/netbox/docs/docs/configuration/
1501 remote-authentication.md
1502 required-parameters.md
1505 share/netbox/docs/docs/customization/
1509 custom-validation.md
1512 share/netbox/docs/docs/development/
1514 application-registry.md
1520 release-checklist.md
1526 share/netbox/docs/docs/features/
1528 authentication-permissions.md
1532 configuration-rendering.md
1543 synchronized-data.md
1548 share/netbox/docs/docs/getting-started/
1551 share/netbox/docs/docs/installation/
1560 share/netbox/docs/docs/integrations/
1562 prometheus-metrics.md
1564 synchronized-data.md
1566 share/netbox/docs/docs/media/
1567 admin_ui_grant_permission.png
1568 admin_ui_run_permission.png
1569 power_distribution.png
1570 share/netbox/docs/docs/media/authentication/
1571 azure_ad_add_app_registration.png
1572 azure_ad_add_client_secret.png
1573 azure_ad_app_registration.png
1574 azure_ad_app_registration_created.png
1575 azure_ad_client_secret.png
1576 azure_ad_client_secret_created.png
1577 azure_ad_login_portal.png
1578 netbox_azure_ad_login.png
1579 netbox_okta_login.png
1580 okta_create_app_registration.png
1581 okta_integration_parameters.png
1582 okta_login_portal.png
1583 okta_web_app_integration.png
1584 share/netbox/docs/docs/media/development/
1586 github_fork_button.png
1587 github_fork_dialog.png
1588 github_new_issue.png
1589 share/netbox/docs/docs/media/installation/
1590 netbox_application_stack.png
1592 share/netbox/docs/docs/media/models/dcim_cable_trace.png
1593 share/netbox/docs/docs/media/release-notes/netbox30_ui.png
1594 share/netbox/docs/docs/media/screenshots/
1600 share/netbox/docs/docs/models/circuits/
1602 circuittermination.md
1607 share/netbox/docs/docs/models/core/
1611 share/netbox/docs/docs/models/dcim/
1614 consoleporttemplate.md
1615 consoleserverport.md
1616 consoleserverporttemplate.md
1619 devicebaytemplate.md
1623 frontporttemplate.md
1625 interfacetemplate.md
1627 inventoryitemrole.md
1628 inventoryitemtemplate.md
1633 modulebaytemplate.md
1638 poweroutlettemplate.md
1641 powerporttemplate.md
1651 virtualdevicecontext.md
1652 share/netbox/docs/docs/models/extras/
1665 share/netbox/docs/docs/models/ipam/
1670 fhrpgroupassignment.md
1684 share/netbox/docs/docs/models/tenancy/
1690 share/netbox/docs/docs/models/virtualization/
1696 share/netbox/docs/docs/models/wireless/
1700 share/netbox/docs/docs/plugins/index.md
1701 share/netbox/docs/docs/plugins/development/
1703 dashboard-widgets.md
1717 share/netbox/docs/docs/reference/
1721 share/netbox/docs/docs/release-notes/
1743 [FILE:155:manifests/plist.examples]
1744 share/examples/netbox/
1748 share/examples/netbox/bsd/
1749 850.netbox-housekeeping.sample
1754 [FILE:578:patches/patch-mkdocs.yml]
1755 --- mkdocs.yml.orig 2023-05-05 16:50:30 UTC
1758 site_name: NetBox Documentation
1759 -site_dir: netbox/project-static/docs
1760 +site_dir: project-static/docs
1761 site_url: https://docs.netbox.dev/
1762 repo_name: netbox-community/netbox
1763 repo_url: https://github.com/netbox-community/netbox
1764 @@ -31,7 +31,6 @@ plugins:
1768 - - os.chdir('netbox/')
1769 - os.environ.setdefault("DJANGO_SETTINGS_MODULE", "netbox.settings")
1774 [FILE:789:files/850.netbox-housekeeping.sample.in]
1776 # This shell script invokes NetBox's housekeeping management command, which
1777 # intended to be run nightly.
1779 # If you want to enable this script, copy it to %%PREFIX%%/etc/periodic/daily
1780 # and place the following into /etc/periodic.conf:
1782 # daily_netbox_housekeeping_enable="YES"
1784 # If NetBox has been installed into a nonstandard location, update the paths
1786 command="%%PYTHON_CMD%%"
1787 netbox_root="%%PREFIX%%/share/netbox"
1789 # If there is a global system configuration file, suck it in.
1791 if [ -r /etc/defaults/periodic.conf ]; then
1792 . /etc/defaults/periodic.conf
1793 source_periodic_confs
1798 case "$daily_netbox_housekeeping_enable" in
1801 echo "Running NetBox housekeeping:"
1802 $command "$netbox_root/manage.py" housekeeping
1809 [FILE:934:files/netbox_rq.sample.in]
1812 # This sample rc script starts the RQ worker background service which is
1813 # required for Webhooks and various automation tasks.
1816 # PROVIDE: netbox_rq
1820 # Add the following line to /etc/rc.conf.local or /etc/rc.conf
1821 # to enable netbox-rq:
1823 # netbox_rq_enable (bool): Set to NO by default.
1824 # Set it to YES to enable netbox_rq.
1829 rcvar=netbox_rq_enable
1831 load_rc_config $name
1833 start_cmd="netbox_rq_start"
1834 start_precmd="netbox_rq_precmd"
1835 command="%%PYTHON_CMD%%"
1836 command_args="%%PREFIX%%/share/netbox/manage.py rqworker"
1837 pidfile=${netbox_rq_pidfile:-/var/run/${name}/${name}.pid}
1838 netbox_rq_user=${netbox_rq_user:-www}
1843 install -d -o ${netbox_rq_user} `dirname ${pidfile}`
1848 echo "Starting netbox_rq."
1849 /usr/sbin/daemon -cf -p ${pidfile} -u ${netbox_rq_user} ${command} ${command_args}
1855 [FILE:3721:files/netboxrc.sample.in]
1858 # This sample rc script eliminate the need to use sysutils/py-supervisor to
1859 # run NetBox as a system service. Only www/py-gunicorn is needed as a WSGI.
1861 # Of course a working HTTP server like Apache/nginx is still required to make
1862 # use of the gunicorn WSGI.
1869 # Add the following line to /etc/rc.conf.local or /etc/rc.conf
1872 # netbox_enable (bool): Set to NO by default.
1873 # Set it to YES to enable netbox.
1874 # netbox_use_config (bool): Set to NO by default.
1875 # If set, read the configuration parameter from file defined in
1876 # "netbox_config" instead using rc variables.
1877 # netbox_config (str): Default to "/usr/local/etc/${name}.conf}"
1878 # Config file for gunicorn's netbox config file
1879 # netbox_command (str): Default to "%%LOCALBASE%%/bin/gunicorn"
1880 # Path to gunicorn to run netbox
1881 # netbox_bind (str): Default to "localhost:8001"
1882 # Interface and port to bind to
1883 # netbox_workers (int): Default to "5"
1884 # Number of gunicorn workers
1885 # netbox_threads (int): Default to "3"
1886 # Number of worker threads per handling request
1887 # netbox_timeout (int): Default to "120"
1888 # Worker timeout for gunicorn
1889 # netbox_max_requests (int): Default to "5000"
1890 # Maximum number of requests a worker process will process before respawning
1891 # netbox_max_requests_jitter (int): Default to "500"
1892 # Maximum number jitter to add to "netbox_max_requests"
1893 # netbox_extra_args (str): Not set by default
1894 # Extra arguments that are passed to gunicorn
1901 netbox_path=%%PREFIX%%/share/netbox
1902 extra_commands="upgrade"
1904 load_rc_config $name
1906 start_precmd="netbox_precmd"
1907 upgrade_cmd="netbox_upgrade"
1908 command=${netbox_program:-%%LOCALBASE%%/bin/gunicorn}
1909 procname=${netbox_procname:-%%PYTHON_CMD%%}
1910 netbox_chdir=${netbox_path}
1911 pidfile=${netbox_pidfile:-/var/run/${name}/${name}.pid}
1912 netbox_user=${netbox_user:-wwwraven}
1913 netbox_use_config=${netbox_use_config:-no}
1914 netbox_config=${netbox_config:-/${name}.conf}
1915 netbox_bind=${netbox_bind:-localhost:8001}
1916 netbox_workers=${netbox_workers:-5}
1917 netbox_threads=${netbox_threads:-3}
1918 netbox_timeout=${netbox_timeout:-120}
1919 netbox_max_requests=${netbox_max_requests:-5000}
1920 netbox_max_requests_jitter=${netbox_max_requests_jitter:-500}
1922 # Read settings from confguration file if set
1923 if checkyesno netbox_use_config && [ -f "${netbox_config}" ]; then
1924 command_args="${netbox_args} -D \
1925 --log-syslog --log-syslog-prefix ${name} \
1926 --log-syslog-to unix:///var/run/log#dgram \
1927 --disable-redirect-access-to-syslog \
1928 -p ${pidfile} --pythonpath ${netbox_path} \
1929 -c ${netbox_config} \
1932 command_args="${netbox_args} -D \
1933 --log-syslog --log-syslog-prefix ${name} \
1934 --log-syslog-to unix:///var/run/log#dgram \
1935 --disable-redirect-access-to-syslog \
1936 -p ${pidfile} --pythonpath ${netbox_path} \
1937 -b ${netbox_bind} -w ${netbox_workers} --threads ${netbox_threads} -t ${netbox_timeout} \
1938 --max-requests ${netbox_max_requests} --max-requests-jitter ${netbox_max_requests_jitter} \
1939 ${netbox_extra_args} \
1945 install -d -o ${netbox_user} `dirname ${pidfile}`
1950 if [ -f ${pidfile} ]; then
1952 %%PYTHON_CMD%% manage.py migrate
1953 %%PYTHON_CMD%% manage.py trace_paths --no-input
1954 %%LOCALBASE%%/bin/mkdocs build
1955 %%PYTHON_CMD%% manage.py collectstatic --no-input
1956 %%PYTHON_CMD%% manage.py remove_stale_contenttypes --no-input
1957 %%PYTHON_CMD%% manage.py clearsessions
1958 %%PYTHON_CMD%% manage.py clearcache
1959 echo "Please restart NetBox and the WSGI environment."
1961 echo "NetBox is not running!"
1968 [FILE:1152:files/pkg-message-primary.in]
1969 Please note that NetBox requires a PostgreSQL database server, which uses its
1970 built-in network address datatypes. Thus NetBox won't work with other RDBMS's,
1971 e.g. MySQL, MariaDB, etc.
1973 For installation instructions please refer to the related wiki page:
1975 - https://wiki.freebsd.org/Ports/net-mgmt/netbox
1981 As always it is strongly encouraged to make a backup of the database before the
1982 database migrations will be executed.
1984 The following steps are required to finish the upgrade:
1986 1. Run database migrations, trace any missing cable paths, build the embedded
1987 documentation, collect static files, remove stale content files, delete any
1988 expired user sessions and clear the cache.
1990 # cd %%PREXIX%%/share/netbox
1991 # python%%PYTHON_VER%% manage.py migrate
1992 # python%%PYTHON_VER%% manage.py trace_paths --no-input
1994 # python%%PYTHON_VER%% manage.py collectstatic --no-input
1995 # python%%PYTHON_VER%% manage.py remove_stale_contenttypes --no-input
1996 # python%%PYTHON_VER%% manage.py clearsessions
1997 # python%%PYTHON_VER%% manage.py clearcache
1999 2. Restart WSGI/httpd environment (supervisord/apache/nginx/etc.)