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.8
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-boto3:single:python_default
30 python-chardet:single:python_default
31 python-django-cors-headers:single:python_default
32 python-django-debug-toolbar:single:python_default
33 python-django-filter:single:python_default
34 python-django-graphiql-debug-toolbar:single:python_default
35 python-django-mptt:single:python_default
36 python-django-pglocks:single:python_default
37 python-django-prometheus:single:python_default
38 python-django-redis:single:python_default
39 python-django-rich:single:python_default
40 python-django-rq:single:python_default
41 python-django-tables2:single:python_default
42 python-django-taggit:single:python_default
43 python-django-timezone-field:single:python_default
44 python-djangorestframework:single:python_default
45 python-drf-spectacular:single:python_default
46 python-drf-spectacular-sidecar:single:python_default
47 python-dulwich:single:python_default
48 python-feedparser:single:python_default
49 python-graphene-django:single:python_default
50 python-gunicorn:single:python_default
51 python-markdown-include:single:python_default
52 python-mkdocs-material:single:python_default
53 python-mkdocstrings:single:python_default
54 python-netaddr:single:python_default
55 python-psycopg2:single:python_default
56 python-sentry-sdk:single:python_default
57 python-social-auth-app-django:single:python_default
58 python-social-auth-core:single:python_default
59 python-svgwrite:single:python_default
60 python-tablib:single:python_default
61 python-tzdata:single:python_default
66 LICENSE= APACHE20:primary
67 LICENSE_TERMS= primary:{{WRKSRC}}/NOTICE
68 LICENSE_FILE= APACHE20:{{WRKSRC}}/LICENSE.txt
72 CPE_VENDOR= netbox_project
73 FPC_EQUIVALENT= net-mgmt/netbox
77 SUB_FILES= 850.netbox-housekeeping.sample
81 SUB_LIST= PYTHON_CMD={{PYTHON_CMD}}
82 PYTHON_VER={{PYTHON_VER}}
85 (cd ${WRKSRC}/netbox && \
86 for src in $$( ${FIND} . ! -name '*.bak' ) ; do \
87 DEST=${STAGEDIR}${PREFIX}/share/netbox/$${src#.} && \
88 if ${TEST} -d "$$src" ; then \
91 ${INSTALL_DATA} "$$src" "$$DEST" ; \
94 cd ${WRKSRC} && ${COPYTREE_SHARE} docs ${STAGEDIR}${PREFIX}/share/netbox/docs
95 ${INSTALL_DATA} ${WRKSRC}/mkdocs.yml ${STAGEDIR}${PREFIX}/share/netbox
96 ${MKDIR} -p ${STAGEDIR}${PREFIX}/share/examples/netbox/bsd
97 ${INSTALL_DATA} ${WRKSRC}/contrib/apache.conf ${STAGEDIR}${PREFIX}/share/examples/netbox
98 ${INSTALL_DATA} ${WRKSRC}/contrib/gunicorn.py ${STAGEDIR}${PREFIX}/share/examples/netbox
99 ${INSTALL_DATA} ${WRKSRC}/contrib/nginx.conf ${STAGEDIR}${PREFIX}/share/examples/netbox
100 ${INSTALL_DATA} ${WRKDIR}/850.netbox-housekeeping.sample ${STAGEDIR}${PREFIX}/share/examples/netbox/bsd
101 ${INSTALL_DATA} ${WRKDIR}/netbox_rq.sample ${STAGEDIR}${PREFIX}/share/examples/netbox/bsd
102 ${INSTALL_DATA} ${WRKDIR}/netboxrc.sample ${STAGEDIR}${PREFIX}/share/examples/netbox/bsd
104 [FILE:1511:descriptions/desc.primary]
105 NetBox is the leading solution for modeling and documenting modern
106 networks. By combining the traditional disciplines of IP address
107 management (IPAM) and datacenter infrastructure management (DCIM) with
108 powerful APIs and extensions, NetBox provides the ideal "source of truth"
109 to power network automation. Available as open source software under the
110 Apache 2.0 license, NetBox is employed by thousands of organizations
113 Myriad infrastructure components can be modeled in NetBox, including:
115 - Hierarchical regions, site groups, sites and locations
116 - Racks, devices, and device components
117 - Cables and wireless connections
118 - Power distribution- Data circuits and providers
119 - Virtual machines and clusters
120 - IP prefixes, ranges and addresses
121 - VRFs and route targets
123 - FHRP groups (VRRP, HSRP, etc.)
125 - VLANs and scoped VLAN groups
126 - Organizational tenants and contacts
128 In addition to its extensive built-in models and functionality, NetBox can
129 be customized and extended through the use of:
133 - Configuration contexts
134 - Custom model validation rules
138 - Conditional webhooks
140 - Single sign-on (SSO) authentication
142 - Detailed change logging
144 NetBox runs as a web application atop the Django Python framework with a
145 PostgreSQL database. It also features a complete REST API as well as a
146 GraphQL API for easy integrating with other tools and systems.
150 1896e70609633f2241be1a542e108899f86fca1b905c9afacecf47fa73811821 5776278 netbox-community-netbox-3.5.8.tar.gz
153 [FILE:25576:manifests/plist.primary]
155 generate_secret_key.py
158 share/netbox/circuits/
167 share/netbox/circuits/api/
169 nested_serializers.py
173 share/netbox/circuits/forms/
179 share/netbox/circuits/graphql/
183 share/netbox/circuits/migrations/
185 0002_squashed_0029.py
186 0003_extend_tag_support.py
187 0004_rename_cable_peer.py
188 0032_provider_service_id.py
189 0033_standardize_id_fields.py
190 0034_created_datetimefield.py
191 0035_provider_asns.py
192 0036_circuit_termination_date_tags_custom_fields.py
193 0037_new_cabling_models.py
194 0038_cabling_cleanup.py
195 0039_unique_constraints.py
196 0040_provider_remove_deprecated_fields.py
197 0041_standardize_description_comments.py
198 0042_provideraccount.py
200 share/netbox/circuits/models/
204 share/netbox/circuits/tables/
209 share/netbox/circuits/tests/
226 share/netbox/core/api/
228 nested_serializers.py
233 share/netbox/core/forms/
240 share/netbox/core/graphql/
244 share/netbox/core/management/__init__.py
245 share/netbox/core/management/commands/
253 share/netbox/core/migrations/
257 0004_replicate_jobresults.py
258 0005_job_created_auto_now.py
260 share/netbox/core/models/
265 share/netbox/core/tables/
269 share/netbox/core/tests/
287 share/netbox/dcim/api/
290 nested_serializers.py
294 share/netbox/dcim/forms/
306 share/netbox/dcim/graphql/
312 share/netbox/dcim/management/__init__.py
313 share/netbox/dcim/management/commands/
317 share/netbox/dcim/migrations/
320 0003_squashed_0130.py
321 0131_consoleport_speed.py
324 0134_interface_wwn_bridge.py
325 0135_tenancy_extensions.py
326 0136_device_airflow.py
327 0137_relax_uniqueness_constraints.py
328 0138_extend_tag_support.py
329 0139_rename_cable_peer.py
332 0142_rename_128gfc_qsfp28.py
333 0143_remove_primary_for_related_name.py
334 0144_fix_cable_abs_length.py
335 0145_site_remove_deprecated_fields.py
337 0147_inventoryitemrole.py
338 0148_inventoryitem_component.py
339 0149_inventoryitem_templates.py
340 0150_interface_vrf.py
341 0151_interface_speed_duplex.py
342 0152_standardize_id_fields.py
343 0153_created_datetimefield.py
344 0154_half_height_rack_units.py
345 0155_interface_poe_mode_type.py
346 0156_location_status.py
347 0157_new_cabling_models.py
348 0158_populate_cable_terminations.py
349 0159_populate_cable_paths.py
350 0160_populate_cable_ends.py
351 0161_cabling_cleanup.py
352 0162_unique_constraints.py
353 0163_weight_fields.py
354 0164_rack_mounting_depth.py
355 0165_standardize_description_comments.py
356 0166_virtualdevicecontext.py
357 0167_module_status.py
358 0168_interface_template_enabled.py
359 0169_devicetype_default_platform.py
360 0170_configtemplate.py
361 0171_cabletermination_change_logging.py
362 0172_larger_power_draw_values.py
364 share/netbox/dcim/models/
367 device_component_templates.py
374 share/netbox/dcim/svg/
378 share/netbox/dcim/tables/
389 share/netbox/dcim/tests/
396 test_natural_ordering.py
421 share/netbox/extras/api/
425 nested_serializers.py
429 share/netbox/extras/dashboard/
434 share/netbox/extras/forms/
445 share/netbox/extras/graphql/
450 share/netbox/extras/management/__init__.py
451 share/netbox/extras/management/commands/
459 share/netbox/extras/migrations/
461 0002_squashed_0059.py
462 0060_customlink_button_class.py
463 0061_extras_change_logging.py
464 0062_clear_secrets_changelog.py
465 0063_webhook_conditions.py
466 0064_configrevision.py
467 0065_imageattachment_change_logging.py
468 0066_customfield_name_validation.py
469 0067_customfield_min_max_values.py
470 0068_configcontext_cluster_types.py
471 0069_custom_object_field.py
472 0070_customlink_enabled.py
473 0071_standardize_id_fields.py
474 0072_created_datetimefield.py
475 0073_journalentry_tags_custom_fields.py
476 0074_customfield_extensions.py
477 0075_configcontext_locations.py
478 0076_tag_slug_unicode.py
479 0077_customlink_extend_text_and_url.py
480 0078_unique_constraints.py
481 0079_scheduled_jobs.py
482 0080_customlink_content_types.py
483 0081_exporttemplate_content_types.py
488 0086_configtemplate.py
490 0088_jobresult_webhooks.py
491 0089_customfield_is_cloneable.py
492 0090_objectchange_index_request_id.py
493 0091_create_managedfiles.py
494 0092_delete_jobresult.py
496 share/netbox/extras/models/
509 share/netbox/extras/plugins/
517 share/netbox/extras/tables/
521 share/netbox/extras/templatetags/
527 share/netbox/extras/tests/
533 test_customvalidator.py
542 share/netbox/extras/tests/dummy_plugin/
554 share/netbox/extras/tests/dummy_plugin/api/
558 share/netbox/extras/tests/dummy_plugin/migrations/
578 share/netbox/ipam/api/
581 nested_serializers.py
585 share/netbox/ipam/forms/
592 share/netbox/ipam/graphql/
598 share/netbox/ipam/management/__init__.py
599 share/netbox/ipam/management/commands/
602 share/netbox/ipam/migrations/
604 0002_squashed_0046.py
605 0047_prefix_depth_children.py
606 0048_prefix_populate_depth_children.py
607 0049_prefix_mark_utilized.py
609 0051_extend_tag_support.py
612 0054_vlangroup_min_max_vids.py
613 0055_servicetemplate.py
614 0056_standardize_id_fields.py
615 0057_created_datetimefield.py
616 0058_ipaddress_nat_inside_nonunique.py
618 0060_alter_l2vpn_slug.py
619 0061_fhrpgroup_name.py
620 0062_unique_constraints.py
621 0063_standardize_description_comments.py
622 0064_clear_search_cache.py
624 0066_iprange_mark_utilized.py
626 share/netbox/ipam/models/
635 share/netbox/ipam/tables/
644 share/netbox/ipam/tests/
651 share/netbox/media/devicetype-images/.gitignore
652 share/netbox/media/image-attachments/.gitignore
657 configuration_example.py
658 configuration_testing.py
661 context_processors.py
672 share/netbox/netbox/api/
683 share/netbox/netbox/api/serializers/
689 share/netbox/netbox/api/viewsets/
692 share/netbox/netbox/config/
695 share/netbox/netbox/forms/
698 share/netbox/netbox/graphql/
706 share/netbox/netbox/models/
709 share/netbox/netbox/navigation/
712 share/netbox/netbox/search/
715 share/netbox/netbox/tables/
719 share/netbox/netbox/tests/
722 test_authentication.py
731 share/netbox/netbox/views/
736 share/netbox/netbox/views/generic/
744 share/netbox/project-static/
754 share/netbox/project-static/dist/
759 materialdesignicons-webfont-DWVXV5L5.woff
760 materialdesignicons-webfont-ER2MFQKM.woff2
761 materialdesignicons-webfont-UHEFFMSX.eot
762 materialdesignicons-webfont-WM6M6ZHQ.ttf
770 share/netbox/project-static/docs/.info
771 share/netbox/project-static/img/
777 netbox_touch-icon-180.png
780 share/netbox/project-static/js/setmode.js
781 share/netbox/project-static/netbox-graphiql/
785 share/netbox/project-static/src/
803 share/netbox/project-static/src/buttons/
813 share/netbox/project-static/src/forms/
818 share/netbox/project-static/src/select/
823 share/netbox/project-static/src/select/api/
828 share/netbox/project-static/src/state/index.ts
829 share/netbox/project-static/src/stores/
835 share/netbox/project-static/src/tables/
838 share/netbox/project-static/styles/
859 share/netbox/reports/__init__.py
860 share/netbox/scripts/__init__.py
861 share/netbox/templates/
870 share/netbox/templates/admin/index.html
871 share/netbox/templates/admin/extras/configrevision/restore.html
872 share/netbox/templates/base/
877 share/netbox/templates/circuits/
879 circuit_terminations_swap.html
880 circuittermination_edit.html
885 share/netbox/templates/circuits/inc/circuit_termination.html
886 share/netbox/templates/core/
891 share/netbox/templates/dcim/
896 component_create.html
897 connections_list.html
899 consoleport_delete.html
900 consoleserverport.html
901 consoleserverport_delete.html
906 devicebay_delete.html
907 devicebay_depopulate.html
908 devicebay_populate.html
913 interface_delete.html
915 inventoryitem_bulk_delete.html
916 inventoryitem_delete.html
917 inventoryitem_edit.html
918 inventoryitemrole.html
927 poweroutlet_delete.html
930 powerport_delete.html
933 rack_elevation_list.html
942 virtualchassis_add.html
943 virtualchassis_add_member.html
944 virtualchassis_edit.html
945 virtualchassis_remove_member.html
946 virtualdevicecontext.html
947 share/netbox/templates/dcim/device/
951 consoleserverports.html
961 share/netbox/templates/dcim/device/inc/interface_table_controls.html
962 share/netbox/templates/dcim/devicetype/
964 component_templates.html
965 share/netbox/templates/dcim/inc/
966 cable_termination.html
967 cable_toggle_buttons.html
968 connection_endpoints.html
969 endpoint_connection.html
970 interface_vlans_table.html
971 nonracked_devices.html
973 share/netbox/templates/dcim/inc/panels/inventory_items.html
974 share/netbox/templates/dcim/moduletype/
976 component_templates.html
977 share/netbox/templates/dcim/rack/
979 non_racked_devices.html
981 share/netbox/templates/dcim/trace/
989 share/netbox/templates/exceptions/
991 permission_error.html
992 programming_error.html
993 share/netbox/templates/extras/
995 configcontext_list.html
997 configtemplate_list.html
1001 exporttemplate_list.html
1002 imageattachment.html
1003 imageattachment_edit.html
1005 object_changelog.html
1006 object_configcontext.html
1009 objectchange_list.html
1019 share/netbox/templates/extras/admin/plugins_list.html
1020 share/netbox/templates/extras/dashboard/
1025 share/netbox/templates/extras/dashboard/widgets/
1029 share/netbox/templates/extras/htmx/
1032 share/netbox/templates/extras/inc/
1033 configcontext_data.html
1034 configcontext_format.html
1036 share/netbox/templates/extras/report/
1040 share/netbox/templates/extras/schema/devicetype_schema.jinja2
1041 share/netbox/templates/extras/script/
1045 share/netbox/templates/extras/templatetags/log_level.html
1046 share/netbox/templates/generic/
1047 bulk_add_component.html
1053 confirmation_form.html
1055 object_children.html
1059 share/netbox/templates/htmx/
1062 object_selector.html
1063 object_selector_results.html
1065 share/netbox/templates/inc/
1069 missing_prerequisites.html
1077 table_controls_htmx.html
1079 share/netbox/templates/inc/panels/
1082 image_attachments.html
1083 related_objects.html
1085 share/netbox/templates/ipam/
1090 fhrpgroupassignment_edit.html
1092 ipaddress_assign.html
1093 ipaddress_bulk_add.html
1097 l2vpntermination.html
1098 l2vpntermination_edit.html
1107 servicetemplate.html
1112 share/netbox/templates/ipam/aggregate/
1115 share/netbox/templates/ipam/asnrange/base.html
1116 share/netbox/templates/ipam/inc/
1117 ipaddress_edit_header.html
1118 toggle_available.html
1119 share/netbox/templates/ipam/inc/panels/fhrp_groups.html
1120 share/netbox/templates/ipam/ipaddress/base.html
1121 share/netbox/templates/ipam/iprange/
1124 share/netbox/templates/ipam/prefix/
1129 share/netbox/templates/ipam/vlan/base.html
1130 share/netbox/templates/rest_framework/api.html
1131 share/netbox/templates/tenancy/
1133 contactassignment_edit.html
1136 object_contacts.html
1139 share/netbox/templates/users/
1146 share/netbox/templates/virtualization/
1148 cluster_add_devices.html
1152 virtualmachine_list.html
1154 share/netbox/templates/virtualization/cluster/
1157 share/netbox/templates/virtualization/virtualmachine/
1160 share/netbox/templates/wireless/
1162 wirelesslangroup.html
1164 share/netbox/templates/wireless/inc/
1165 authentication_attrs.html
1166 wirelesslink_interface.html
1167 share/netbox/tenancy/
1175 share/netbox/tenancy/api/
1177 nested_serializers.py
1181 share/netbox/tenancy/forms/
1188 share/netbox/tenancy/graphql/
1192 share/netbox/tenancy/migrations/
1193 0001_squashed_0012.py
1194 0002_tenant_ordering.py
1196 0004_extend_tag_support.py
1197 0005_standardize_id_fields.py
1198 0006_created_datetimefield.py
1199 0007_contact_link.py
1200 0008_unique_constraints.py
1201 0009_standardize_description_comments.py
1202 0010_tenant_relax_uniqueness.py
1204 share/netbox/tenancy/models/
1208 share/netbox/tenancy/tables/
1213 share/netbox/tenancy/tests/
1231 share/netbox/users/admin/
1236 share/netbox/users/api/
1238 nested_serializers.py
1242 share/netbox/users/graphql/
1246 share/netbox/users/migrations/
1247 0001_squashed_0011.py
1248 0002_standardize_id_fields.py
1249 0003_token_allowed_ips_last_used.py
1251 share/netbox/users/tests/
1257 share/netbox/utilities/
1267 graphql_optimizer.py
1286 share/netbox/utilities/forms/
1293 share/netbox/utilities/forms/fields/
1301 share/netbox/utilities/forms/widgets/
1307 share/netbox/utilities/serializers/json.py
1308 share/netbox/utilities/templates/builtins/
1312 customfield_value.html
1315 share/netbox/utilities/templates/buttons/
1325 share/netbox/utilities/templates/form_helpers/
1326 render_custom_fields.html
1330 share/netbox/utilities/templates/helpers/
1331 applied_filters.html
1332 table_config_form.html
1333 utilization_graph.html
1334 share/netbox/utilities/templates/navigation/menu.html
1335 share/netbox/utilities/templates/tabs/model_view_tabs.html
1336 share/netbox/utilities/templates/widgets/
1338 clearable_file_input.html
1339 colorselect_option.html
1341 number_with_options.html
1343 select_option_with_pk.html
1345 share/netbox/utilities/templatetags/
1353 share/netbox/utilities/templatetags/builtins/
1357 share/netbox/utilities/testing/
1364 share/netbox/utilities/tests/
1373 share/netbox/virtualization/
1381 share/netbox/virtualization/api/
1383 nested_serializers.py
1387 share/netbox/virtualization/forms/
1395 share/netbox/virtualization/graphql/
1399 share/netbox/virtualization/migrations/
1400 0001_squashed_0022.py
1401 0023_virtualmachine_natural_ordering.py
1402 0024_cluster_relax_uniqueness.py
1403 0025_extend_tag_support.py
1404 0026_vminterface_bridge.py
1405 0027_standardize_id_fields.py
1406 0028_vminterface_vrf.py
1407 0029_created_datetimefield.py
1408 0030_cluster_status.py
1409 0031_virtualmachine_site_device.py
1410 0032_virtualmachine_update_sites.py
1411 0033_unique_constraints.py
1412 0034_standardize_description_comments.py
1414 share/netbox/virtualization/models/
1418 share/netbox/virtualization/tables/
1422 share/netbox/virtualization/tests/
1428 share/netbox/wireless/
1440 share/netbox/wireless/api/
1442 nested_serializers.py
1446 share/netbox/wireless/forms/
1452 share/netbox/wireless/graphql/
1456 share/netbox/wireless/migrations/
1458 0002_standardize_id_fields.py
1459 0003_created_datetimefield.py
1460 0004_wireless_tenancy.py
1461 0005_wirelesslink_interface_types.py
1462 0006_unique_constraints.py
1463 0007_standardize_description_comments.py
1464 0008_wirelesslan_status.py
1466 share/netbox/wireless/tables/
1470 share/netbox/wireless/tests/
1477 [FILE:5239:manifests/plist.docs]
1478 share/netbox/docs/docs/
1484 share/netbox/docs/docs/_theme/main.html
1485 share/netbox/docs/docs/administration/
1490 replicating-netbox.md
1491 share/netbox/docs/docs/administration/authentication/
1492 microsoft-azure-ad.md
1495 share/netbox/docs/docs/configuration/
1504 remote-authentication.md
1505 required-parameters.md
1508 share/netbox/docs/docs/customization/
1512 custom-validation.md
1515 share/netbox/docs/docs/development/
1517 application-registry.md
1523 release-checklist.md
1529 share/netbox/docs/docs/features/
1531 authentication-permissions.md
1535 configuration-rendering.md
1546 synchronized-data.md
1551 share/netbox/docs/docs/getting-started/
1554 share/netbox/docs/docs/installation/
1563 share/netbox/docs/docs/integrations/
1565 prometheus-metrics.md
1567 synchronized-data.md
1569 share/netbox/docs/docs/media/
1570 admin_ui_grant_permission.png
1571 admin_ui_run_permission.png
1572 power_distribution.png
1573 share/netbox/docs/docs/media/authentication/
1574 azure_ad_add_app_registration.png
1575 azure_ad_add_client_secret.png
1576 azure_ad_app_registration.png
1577 azure_ad_app_registration_created.png
1578 azure_ad_client_secret.png
1579 azure_ad_client_secret_created.png
1580 azure_ad_login_portal.png
1581 netbox_azure_ad_login.png
1582 netbox_okta_login.png
1583 okta_create_app_registration.png
1584 okta_integration_parameters.png
1585 okta_login_portal.png
1586 okta_web_app_integration.png
1587 share/netbox/docs/docs/media/development/
1589 github_fork_button.png
1590 github_fork_dialog.png
1591 github_new_issue.png
1592 share/netbox/docs/docs/media/installation/
1593 netbox_application_stack.png
1595 share/netbox/docs/docs/media/models/dcim_cable_trace.png
1596 share/netbox/docs/docs/media/release-notes/netbox30_ui.png
1597 share/netbox/docs/docs/media/screenshots/
1603 share/netbox/docs/docs/models/circuits/
1605 circuittermination.md
1610 share/netbox/docs/docs/models/core/
1614 share/netbox/docs/docs/models/dcim/
1617 consoleporttemplate.md
1618 consoleserverport.md
1619 consoleserverporttemplate.md
1622 devicebaytemplate.md
1626 frontporttemplate.md
1628 interfacetemplate.md
1630 inventoryitemrole.md
1631 inventoryitemtemplate.md
1636 modulebaytemplate.md
1641 poweroutlettemplate.md
1644 powerporttemplate.md
1654 virtualdevicecontext.md
1655 share/netbox/docs/docs/models/extras/
1668 share/netbox/docs/docs/models/ipam/
1673 fhrpgroupassignment.md
1687 share/netbox/docs/docs/models/tenancy/
1693 share/netbox/docs/docs/models/virtualization/
1699 share/netbox/docs/docs/models/wireless/
1703 share/netbox/docs/docs/plugins/index.md
1704 share/netbox/docs/docs/plugins/development/
1706 dashboard-widgets.md
1720 share/netbox/docs/docs/reference/
1724 share/netbox/docs/docs/release-notes/
1746 [FILE:155:manifests/plist.examples]
1747 share/examples/netbox/
1751 share/examples/netbox/bsd/
1752 850.netbox-housekeeping.sample
1757 [FILE:578:patches/patch-mkdocs.yml]
1758 --- mkdocs.yml.orig 2023-08-15 13:56:23 UTC
1761 site_name: NetBox Documentation
1762 -site_dir: netbox/project-static/docs
1763 +site_dir: project-static/docs
1764 site_url: https://docs.netbox.dev/
1765 repo_name: netbox-community/netbox
1766 repo_url: https://github.com/netbox-community/netbox
1767 @@ -31,7 +31,6 @@ plugins:
1771 - - os.chdir('netbox/')
1772 - os.environ.setdefault("DJANGO_SETTINGS_MODULE", "netbox.settings")
1777 [FILE:789:files/850.netbox-housekeeping.sample.in]
1779 # This shell script invokes NetBox's housekeeping management command, which
1780 # intended to be run nightly.
1782 # If you want to enable this script, copy it to %%PREFIX%%/etc/periodic/daily
1783 # and place the following into /etc/periodic.conf:
1785 # daily_netbox_housekeeping_enable="YES"
1787 # If NetBox has been installed into a nonstandard location, update the paths
1789 command="%%PYTHON_CMD%%"
1790 netbox_root="%%PREFIX%%/share/netbox"
1792 # If there is a global system configuration file, suck it in.
1794 if [ -r /etc/defaults/periodic.conf ]; then
1795 . /etc/defaults/periodic.conf
1796 source_periodic_confs
1801 case "$daily_netbox_housekeeping_enable" in
1804 echo "Running NetBox housekeeping:"
1805 $command "$netbox_root/manage.py" housekeeping
1812 [FILE:934:files/netbox_rq.sample.in]
1815 # This sample rc script starts the RQ worker background service which is
1816 # required for Webhooks and various automation tasks.
1819 # PROVIDE: netbox_rq
1823 # Add the following line to /etc/rc.conf.local or /etc/rc.conf
1824 # to enable netbox-rq:
1826 # netbox_rq_enable (bool): Set to NO by default.
1827 # Set it to YES to enable netbox_rq.
1832 rcvar=netbox_rq_enable
1834 load_rc_config $name
1836 start_cmd="netbox_rq_start"
1837 start_precmd="netbox_rq_precmd"
1838 command="%%PYTHON_CMD%%"
1839 command_args="%%PREFIX%%/share/netbox/manage.py rqworker"
1840 pidfile=${netbox_rq_pidfile:-/var/run/${name}/${name}.pid}
1841 netbox_rq_user=${netbox_rq_user:-www}
1846 install -d -o ${netbox_rq_user} `dirname ${pidfile}`
1851 echo "Starting netbox_rq."
1852 /usr/sbin/daemon -cf -p ${pidfile} -u ${netbox_rq_user} ${command} ${command_args}
1858 [FILE:3721:files/netboxrc.sample.in]
1861 # This sample rc script eliminate the need to use sysutils/py-supervisor to
1862 # run NetBox as a system service. Only www/py-gunicorn is needed as a WSGI.
1864 # Of course a working HTTP server like Apache/nginx is still required to make
1865 # use of the gunicorn WSGI.
1872 # Add the following line to /etc/rc.conf.local or /etc/rc.conf
1875 # netbox_enable (bool): Set to NO by default.
1876 # Set it to YES to enable netbox.
1877 # netbox_use_config (bool): Set to NO by default.
1878 # If set, read the configuration parameter from file defined in
1879 # "netbox_config" instead using rc variables.
1880 # netbox_config (str): Default to "/usr/local/etc/${name}.conf}"
1881 # Config file for gunicorn's netbox config file
1882 # netbox_command (str): Default to "%%LOCALBASE%%/bin/gunicorn"
1883 # Path to gunicorn to run netbox
1884 # netbox_bind (str): Default to "localhost:8001"
1885 # Interface and port to bind to
1886 # netbox_workers (int): Default to "5"
1887 # Number of gunicorn workers
1888 # netbox_threads (int): Default to "3"
1889 # Number of worker threads per handling request
1890 # netbox_timeout (int): Default to "120"
1891 # Worker timeout for gunicorn
1892 # netbox_max_requests (int): Default to "5000"
1893 # Maximum number of requests a worker process will process before respawning
1894 # netbox_max_requests_jitter (int): Default to "500"
1895 # Maximum number jitter to add to "netbox_max_requests"
1896 # netbox_extra_args (str): Not set by default
1897 # Extra arguments that are passed to gunicorn
1904 netbox_path=%%PREFIX%%/share/netbox
1905 extra_commands="upgrade"
1907 load_rc_config $name
1909 start_precmd="netbox_precmd"
1910 upgrade_cmd="netbox_upgrade"
1911 command=${netbox_program:-%%LOCALBASE%%/bin/gunicorn}
1912 procname=${netbox_procname:-%%PYTHON_CMD%%}
1913 netbox_chdir=${netbox_path}
1914 pidfile=${netbox_pidfile:-/var/run/${name}/${name}.pid}
1915 netbox_user=${netbox_user:-wwwraven}
1916 netbox_use_config=${netbox_use_config:-no}
1917 netbox_config=${netbox_config:-/${name}.conf}
1918 netbox_bind=${netbox_bind:-localhost:8001}
1919 netbox_workers=${netbox_workers:-5}
1920 netbox_threads=${netbox_threads:-3}
1921 netbox_timeout=${netbox_timeout:-120}
1922 netbox_max_requests=${netbox_max_requests:-5000}
1923 netbox_max_requests_jitter=${netbox_max_requests_jitter:-500}
1925 # Read settings from confguration file if set
1926 if checkyesno netbox_use_config && [ -f "${netbox_config}" ]; then
1927 command_args="${netbox_args} -D \
1928 --log-syslog --log-syslog-prefix ${name} \
1929 --log-syslog-to unix:///var/run/log#dgram \
1930 --disable-redirect-access-to-syslog \
1931 -p ${pidfile} --pythonpath ${netbox_path} \
1932 -c ${netbox_config} \
1935 command_args="${netbox_args} -D \
1936 --log-syslog --log-syslog-prefix ${name} \
1937 --log-syslog-to unix:///var/run/log#dgram \
1938 --disable-redirect-access-to-syslog \
1939 -p ${pidfile} --pythonpath ${netbox_path} \
1940 -b ${netbox_bind} -w ${netbox_workers} --threads ${netbox_threads} -t ${netbox_timeout} \
1941 --max-requests ${netbox_max_requests} --max-requests-jitter ${netbox_max_requests_jitter} \
1942 ${netbox_extra_args} \
1948 install -d -o ${netbox_user} `dirname ${pidfile}`
1953 if [ -f ${pidfile} ]; then
1955 %%PYTHON_CMD%% manage.py migrate
1956 %%PYTHON_CMD%% manage.py trace_paths --no-input
1957 %%LOCALBASE%%/bin/mkdocs build
1958 %%PYTHON_CMD%% manage.py collectstatic --no-input
1959 %%PYTHON_CMD%% manage.py remove_stale_contenttypes --no-input
1960 %%PYTHON_CMD%% manage.py clearsessions
1961 %%PYTHON_CMD%% manage.py clearcache
1962 echo "Please restart NetBox and the WSGI environment."
1964 echo "NetBox is not running!"
1971 [FILE:1152:files/pkg-message-primary.in]
1972 Please note that NetBox requires a PostgreSQL database server, which uses its
1973 built-in network address datatypes. Thus NetBox won't work with other RDBMS's,
1974 e.g. MySQL, MariaDB, etc.
1976 For installation instructions please refer to the related wiki page:
1978 - https://wiki.freebsd.org/Ports/net-mgmt/netbox
1984 As always it is strongly encouraged to make a backup of the database before the
1985 database migrations will be executed.
1987 The following steps are required to finish the upgrade:
1989 1. Run database migrations, trace any missing cable paths, build the embedded
1990 documentation, collect static files, remove stale content files, delete any
1991 expired user sessions and clear the cache.
1993 # cd %%PREXIX%%/share/netbox
1994 # python%%PYTHON_VER%% manage.py migrate
1995 # python%%PYTHON_VER%% manage.py trace_paths --no-input
1997 # python%%PYTHON_VER%% manage.py collectstatic --no-input
1998 # python%%PYTHON_VER%% manage.py remove_stale_contenttypes --no-input
1999 # python%%PYTHON_VER%% manage.py clearsessions
2000 # python%%PYTHON_VER%% manage.py clearcache
2002 2. Restart WSGI/httpd environment (supervisord/apache/nginx/etc.)