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.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-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 17f057b21539bd1d90c5ea1ddb77746e29da49df67b137f88d433988922d9db8 5774576 netbox-community-netbox-3.5.7.tar.gz
153 [FILE:25517: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/
316 share/netbox/dcim/migrations/
319 0003_squashed_0130.py
320 0131_consoleport_speed.py
323 0134_interface_wwn_bridge.py
324 0135_tenancy_extensions.py
325 0136_device_airflow.py
326 0137_relax_uniqueness_constraints.py
327 0138_extend_tag_support.py
328 0139_rename_cable_peer.py
331 0142_rename_128gfc_qsfp28.py
332 0143_remove_primary_for_related_name.py
333 0144_fix_cable_abs_length.py
334 0145_site_remove_deprecated_fields.py
336 0147_inventoryitemrole.py
337 0148_inventoryitem_component.py
338 0149_inventoryitem_templates.py
339 0150_interface_vrf.py
340 0151_interface_speed_duplex.py
341 0152_standardize_id_fields.py
342 0153_created_datetimefield.py
343 0154_half_height_rack_units.py
344 0155_interface_poe_mode_type.py
345 0156_location_status.py
346 0157_new_cabling_models.py
347 0158_populate_cable_terminations.py
348 0159_populate_cable_paths.py
349 0160_populate_cable_ends.py
350 0161_cabling_cleanup.py
351 0162_unique_constraints.py
352 0163_weight_fields.py
353 0164_rack_mounting_depth.py
354 0165_standardize_description_comments.py
355 0166_virtualdevicecontext.py
356 0167_module_status.py
357 0168_interface_template_enabled.py
358 0169_devicetype_default_platform.py
359 0170_configtemplate.py
360 0171_cabletermination_change_logging.py
361 0172_larger_power_draw_values.py
363 share/netbox/dcim/models/
366 device_component_templates.py
373 share/netbox/dcim/svg/
377 share/netbox/dcim/tables/
388 share/netbox/dcim/tests/
395 test_natural_ordering.py
420 share/netbox/extras/api/
424 nested_serializers.py
428 share/netbox/extras/dashboard/
433 share/netbox/extras/forms/
444 share/netbox/extras/graphql/
449 share/netbox/extras/management/__init__.py
450 share/netbox/extras/management/commands/
458 share/netbox/extras/migrations/
460 0002_squashed_0059.py
461 0060_customlink_button_class.py
462 0061_extras_change_logging.py
463 0062_clear_secrets_changelog.py
464 0063_webhook_conditions.py
465 0064_configrevision.py
466 0065_imageattachment_change_logging.py
467 0066_customfield_name_validation.py
468 0067_customfield_min_max_values.py
469 0068_configcontext_cluster_types.py
470 0069_custom_object_field.py
471 0070_customlink_enabled.py
472 0071_standardize_id_fields.py
473 0072_created_datetimefield.py
474 0073_journalentry_tags_custom_fields.py
475 0074_customfield_extensions.py
476 0075_configcontext_locations.py
477 0076_tag_slug_unicode.py
478 0077_customlink_extend_text_and_url.py
479 0078_unique_constraints.py
480 0079_scheduled_jobs.py
481 0080_customlink_content_types.py
482 0081_exporttemplate_content_types.py
487 0086_configtemplate.py
489 0088_jobresult_webhooks.py
490 0089_customfield_is_cloneable.py
491 0090_objectchange_index_request_id.py
492 0091_create_managedfiles.py
493 0092_delete_jobresult.py
495 share/netbox/extras/models/
508 share/netbox/extras/plugins/
515 share/netbox/extras/tables/
519 share/netbox/extras/templatetags/
525 share/netbox/extras/tests/
531 test_customvalidator.py
540 share/netbox/extras/tests/dummy_plugin/
552 share/netbox/extras/tests/dummy_plugin/api/
556 share/netbox/extras/tests/dummy_plugin/migrations/
576 share/netbox/ipam/api/
579 nested_serializers.py
583 share/netbox/ipam/forms/
590 share/netbox/ipam/graphql/
596 share/netbox/ipam/management/__init__.py
597 share/netbox/ipam/management/commands/
600 share/netbox/ipam/migrations/
602 0002_squashed_0046.py
603 0047_prefix_depth_children.py
604 0048_prefix_populate_depth_children.py
605 0049_prefix_mark_utilized.py
607 0051_extend_tag_support.py
610 0054_vlangroup_min_max_vids.py
611 0055_servicetemplate.py
612 0056_standardize_id_fields.py
613 0057_created_datetimefield.py
614 0058_ipaddress_nat_inside_nonunique.py
616 0060_alter_l2vpn_slug.py
617 0061_fhrpgroup_name.py
618 0062_unique_constraints.py
619 0063_standardize_description_comments.py
620 0064_clear_search_cache.py
622 0066_iprange_mark_utilized.py
624 share/netbox/ipam/models/
633 share/netbox/ipam/tables/
642 share/netbox/ipam/tests/
649 share/netbox/media/devicetype-images/.gitignore
650 share/netbox/media/image-attachments/.gitignore
655 configuration_example.py
656 configuration_testing.py
659 context_processors.py
670 share/netbox/netbox/api/
681 share/netbox/netbox/api/serializers/
687 share/netbox/netbox/api/viewsets/
690 share/netbox/netbox/config/
693 share/netbox/netbox/forms/
696 share/netbox/netbox/graphql/
704 share/netbox/netbox/models/
707 share/netbox/netbox/navigation/
710 share/netbox/netbox/search/
713 share/netbox/netbox/tables/
717 share/netbox/netbox/tests/
720 test_authentication.py
729 share/netbox/netbox/views/
734 share/netbox/netbox/views/generic/
742 share/netbox/project-static/
752 share/netbox/project-static/dist/
757 materialdesignicons-webfont-DWVXV5L5.woff
758 materialdesignicons-webfont-ER2MFQKM.woff2
759 materialdesignicons-webfont-UHEFFMSX.eot
760 materialdesignicons-webfont-WM6M6ZHQ.ttf
768 share/netbox/project-static/docs/.info
769 share/netbox/project-static/img/
775 netbox_touch-icon-180.png
778 share/netbox/project-static/js/setmode.js
779 share/netbox/project-static/netbox-graphiql/
783 share/netbox/project-static/src/
801 share/netbox/project-static/src/buttons/
811 share/netbox/project-static/src/forms/
816 share/netbox/project-static/src/select/
821 share/netbox/project-static/src/select/api/
826 share/netbox/project-static/src/state/index.ts
827 share/netbox/project-static/src/stores/
833 share/netbox/project-static/src/tables/
836 share/netbox/project-static/styles/
857 share/netbox/reports/__init__.py
858 share/netbox/scripts/__init__.py
859 share/netbox/templates/
868 share/netbox/templates/admin/index.html
869 share/netbox/templates/admin/extras/configrevision/restore.html
870 share/netbox/templates/base/
875 share/netbox/templates/circuits/
877 circuit_terminations_swap.html
878 circuittermination_edit.html
883 share/netbox/templates/circuits/inc/circuit_termination.html
884 share/netbox/templates/core/
889 share/netbox/templates/dcim/
894 component_create.html
895 connections_list.html
897 consoleport_delete.html
898 consoleserverport.html
899 consoleserverport_delete.html
904 devicebay_delete.html
905 devicebay_depopulate.html
906 devicebay_populate.html
911 interface_delete.html
913 inventoryitem_bulk_delete.html
914 inventoryitem_delete.html
915 inventoryitem_edit.html
916 inventoryitemrole.html
925 poweroutlet_delete.html
928 powerport_delete.html
931 rack_elevation_list.html
940 virtualchassis_add.html
941 virtualchassis_add_member.html
942 virtualchassis_edit.html
943 virtualchassis_remove_member.html
944 virtualdevicecontext.html
945 share/netbox/templates/dcim/device/
948 consoleserverports.html
958 share/netbox/templates/dcim/device/inc/interface_table_controls.html
959 share/netbox/templates/dcim/devicetype/
961 component_templates.html
962 share/netbox/templates/dcim/inc/
963 cable_termination.html
964 cable_toggle_buttons.html
965 connection_endpoints.html
966 endpoint_connection.html
967 interface_vlans_table.html
968 nonracked_devices.html
970 share/netbox/templates/dcim/inc/panels/inventory_items.html
971 share/netbox/templates/dcim/moduletype/
973 component_templates.html
974 share/netbox/templates/dcim/rack/
976 non_racked_devices.html
978 share/netbox/templates/dcim/trace/
986 share/netbox/templates/exceptions/
988 permission_error.html
989 programming_error.html
990 share/netbox/templates/extras/
992 configcontext_list.html
994 configtemplate_list.html
998 exporttemplate_list.html
999 imageattachment_edit.html
1001 object_changelog.html
1002 object_configcontext.html
1005 objectchange_list.html
1015 share/netbox/templates/extras/admin/plugins_list.html
1016 share/netbox/templates/extras/dashboard/
1021 share/netbox/templates/extras/dashboard/widgets/
1025 share/netbox/templates/extras/htmx/
1028 share/netbox/templates/extras/inc/
1029 configcontext_data.html
1030 configcontext_format.html
1032 share/netbox/templates/extras/report/
1036 share/netbox/templates/extras/script/
1040 share/netbox/templates/extras/templatetags/log_level.html
1041 share/netbox/templates/generic/
1042 bulk_add_component.html
1048 confirmation_form.html
1053 share/netbox/templates/htmx/
1056 object_selector.html
1057 object_selector_results.html
1059 share/netbox/templates/inc/
1063 missing_prerequisites.html
1071 table_controls_htmx.html
1073 share/netbox/templates/inc/panels/
1076 image_attachments.html
1077 related_objects.html
1079 share/netbox/templates/ipam/
1084 fhrpgroupassignment_edit.html
1086 ipaddress_assign.html
1087 ipaddress_bulk_add.html
1091 l2vpntermination.html
1092 l2vpntermination_edit.html
1101 servicetemplate.html
1106 share/netbox/templates/ipam/aggregate/
1109 share/netbox/templates/ipam/asnrange/
1112 share/netbox/templates/ipam/inc/
1113 ipaddress_edit_header.html
1114 toggle_available.html
1115 share/netbox/templates/ipam/inc/panels/fhrp_groups.html
1116 share/netbox/templates/ipam/ipaddress/
1119 share/netbox/templates/ipam/iprange/
1122 share/netbox/templates/ipam/prefix/
1127 share/netbox/templates/ipam/vlan/
1131 share/netbox/templates/rest_framework/api.html
1132 share/netbox/templates/tenancy/
1134 contactassignment_edit.html
1137 object_contacts.html
1140 share/netbox/templates/users/
1147 share/netbox/templates/virtualization/
1149 cluster_add_devices.html
1153 virtualmachine_list.html
1155 share/netbox/templates/virtualization/cluster/
1158 virtual_machines.html
1159 share/netbox/templates/virtualization/virtualmachine/
1162 share/netbox/templates/wireless/
1164 wirelesslangroup.html
1166 share/netbox/templates/wireless/inc/
1167 authentication_attrs.html
1168 wirelesslink_interface.html
1169 share/netbox/tenancy/
1177 share/netbox/tenancy/api/
1179 nested_serializers.py
1183 share/netbox/tenancy/forms/
1190 share/netbox/tenancy/graphql/
1194 share/netbox/tenancy/migrations/
1195 0001_squashed_0012.py
1196 0002_tenant_ordering.py
1198 0004_extend_tag_support.py
1199 0005_standardize_id_fields.py
1200 0006_created_datetimefield.py
1201 0007_contact_link.py
1202 0008_unique_constraints.py
1203 0009_standardize_description_comments.py
1204 0010_tenant_relax_uniqueness.py
1206 share/netbox/tenancy/models/
1210 share/netbox/tenancy/tables/
1215 share/netbox/tenancy/tests/
1233 share/netbox/users/admin/
1238 share/netbox/users/api/
1240 nested_serializers.py
1244 share/netbox/users/graphql/
1248 share/netbox/users/migrations/
1249 0001_squashed_0011.py
1250 0002_standardize_id_fields.py
1251 0003_token_allowed_ips_last_used.py
1253 share/netbox/users/tests/
1259 share/netbox/utilities/
1269 graphql_optimizer.py
1288 share/netbox/utilities/forms/
1295 share/netbox/utilities/forms/fields/
1303 share/netbox/utilities/forms/widgets/
1309 share/netbox/utilities/serializers/json.py
1310 share/netbox/utilities/templates/builtins/
1314 customfield_value.html
1317 share/netbox/utilities/templates/buttons/
1327 share/netbox/utilities/templates/form_helpers/
1328 render_custom_fields.html
1332 share/netbox/utilities/templates/helpers/
1333 applied_filters.html
1334 table_config_form.html
1335 utilization_graph.html
1336 share/netbox/utilities/templates/navigation/menu.html
1337 share/netbox/utilities/templates/tabs/model_view_tabs.html
1338 share/netbox/utilities/templates/widgets/
1340 clearable_file_input.html
1341 colorselect_option.html
1343 number_with_options.html
1345 select_option_with_pk.html
1347 share/netbox/utilities/templatetags/
1355 share/netbox/utilities/templatetags/builtins/
1359 share/netbox/utilities/testing/
1366 share/netbox/utilities/tests/
1375 share/netbox/virtualization/
1383 share/netbox/virtualization/api/
1385 nested_serializers.py
1389 share/netbox/virtualization/forms/
1397 share/netbox/virtualization/graphql/
1401 share/netbox/virtualization/migrations/
1402 0001_squashed_0022.py
1403 0023_virtualmachine_natural_ordering.py
1404 0024_cluster_relax_uniqueness.py
1405 0025_extend_tag_support.py
1406 0026_vminterface_bridge.py
1407 0027_standardize_id_fields.py
1408 0028_vminterface_vrf.py
1409 0029_created_datetimefield.py
1410 0030_cluster_status.py
1411 0031_virtualmachine_site_device.py
1412 0032_virtualmachine_update_sites.py
1413 0033_unique_constraints.py
1414 0034_standardize_description_comments.py
1416 share/netbox/virtualization/models/
1420 share/netbox/virtualization/tables/
1424 share/netbox/virtualization/tests/
1430 share/netbox/wireless/
1442 share/netbox/wireless/api/
1444 nested_serializers.py
1448 share/netbox/wireless/forms/
1454 share/netbox/wireless/graphql/
1458 share/netbox/wireless/migrations/
1460 0002_standardize_id_fields.py
1461 0003_created_datetimefield.py
1462 0004_wireless_tenancy.py
1463 0005_wirelesslink_interface_types.py
1464 0006_unique_constraints.py
1465 0007_standardize_description_comments.py
1466 0008_wirelesslan_status.py
1468 share/netbox/wireless/tables/
1472 share/netbox/wireless/tests/
1479 [FILE:5239:manifests/plist.docs]
1480 share/netbox/docs/docs/
1486 share/netbox/docs/docs/_theme/main.html
1487 share/netbox/docs/docs/administration/
1492 replicating-netbox.md
1493 share/netbox/docs/docs/administration/authentication/
1494 microsoft-azure-ad.md
1497 share/netbox/docs/docs/configuration/
1506 remote-authentication.md
1507 required-parameters.md
1510 share/netbox/docs/docs/customization/
1514 custom-validation.md
1517 share/netbox/docs/docs/development/
1519 application-registry.md
1525 release-checklist.md
1531 share/netbox/docs/docs/features/
1533 authentication-permissions.md
1537 configuration-rendering.md
1548 synchronized-data.md
1553 share/netbox/docs/docs/getting-started/
1556 share/netbox/docs/docs/installation/
1565 share/netbox/docs/docs/integrations/
1567 prometheus-metrics.md
1569 synchronized-data.md
1571 share/netbox/docs/docs/media/
1572 admin_ui_grant_permission.png
1573 admin_ui_run_permission.png
1574 power_distribution.png
1575 share/netbox/docs/docs/media/authentication/
1576 azure_ad_add_app_registration.png
1577 azure_ad_add_client_secret.png
1578 azure_ad_app_registration.png
1579 azure_ad_app_registration_created.png
1580 azure_ad_client_secret.png
1581 azure_ad_client_secret_created.png
1582 azure_ad_login_portal.png
1583 netbox_azure_ad_login.png
1584 netbox_okta_login.png
1585 okta_create_app_registration.png
1586 okta_integration_parameters.png
1587 okta_login_portal.png
1588 okta_web_app_integration.png
1589 share/netbox/docs/docs/media/development/
1591 github_fork_button.png
1592 github_fork_dialog.png
1593 github_new_issue.png
1594 share/netbox/docs/docs/media/installation/
1595 netbox_application_stack.png
1597 share/netbox/docs/docs/media/models/dcim_cable_trace.png
1598 share/netbox/docs/docs/media/release-notes/netbox30_ui.png
1599 share/netbox/docs/docs/media/screenshots/
1605 share/netbox/docs/docs/models/circuits/
1607 circuittermination.md
1612 share/netbox/docs/docs/models/core/
1616 share/netbox/docs/docs/models/dcim/
1619 consoleporttemplate.md
1620 consoleserverport.md
1621 consoleserverporttemplate.md
1624 devicebaytemplate.md
1628 frontporttemplate.md
1630 interfacetemplate.md
1632 inventoryitemrole.md
1633 inventoryitemtemplate.md
1638 modulebaytemplate.md
1643 poweroutlettemplate.md
1646 powerporttemplate.md
1656 virtualdevicecontext.md
1657 share/netbox/docs/docs/models/extras/
1670 share/netbox/docs/docs/models/ipam/
1675 fhrpgroupassignment.md
1689 share/netbox/docs/docs/models/tenancy/
1695 share/netbox/docs/docs/models/virtualization/
1701 share/netbox/docs/docs/models/wireless/
1705 share/netbox/docs/docs/plugins/index.md
1706 share/netbox/docs/docs/plugins/development/
1708 dashboard-widgets.md
1722 share/netbox/docs/docs/reference/
1726 share/netbox/docs/docs/release-notes/
1748 [FILE:155:manifests/plist.examples]
1749 share/examples/netbox/
1753 share/examples/netbox/bsd/
1754 850.netbox-housekeeping.sample
1759 [FILE:578:patches/patch-mkdocs.yml]
1760 --- mkdocs.yml.orig 2023-07-10 20:53:46 UTC
1763 site_name: NetBox Documentation
1764 -site_dir: netbox/project-static/docs
1765 +site_dir: project-static/docs
1766 site_url: https://docs.netbox.dev/
1767 repo_name: netbox-community/netbox
1768 repo_url: https://github.com/netbox-community/netbox
1769 @@ -31,7 +31,6 @@ plugins:
1773 - - os.chdir('netbox/')
1774 - os.environ.setdefault("DJANGO_SETTINGS_MODULE", "netbox.settings")
1779 [FILE:789:files/850.netbox-housekeeping.sample.in]
1781 # This shell script invokes NetBox's housekeeping management command, which
1782 # intended to be run nightly.
1784 # If you want to enable this script, copy it to %%PREFIX%%/etc/periodic/daily
1785 # and place the following into /etc/periodic.conf:
1787 # daily_netbox_housekeeping_enable="YES"
1789 # If NetBox has been installed into a nonstandard location, update the paths
1791 command="%%PYTHON_CMD%%"
1792 netbox_root="%%PREFIX%%/share/netbox"
1794 # If there is a global system configuration file, suck it in.
1796 if [ -r /etc/defaults/periodic.conf ]; then
1797 . /etc/defaults/periodic.conf
1798 source_periodic_confs
1803 case "$daily_netbox_housekeeping_enable" in
1806 echo "Running NetBox housekeeping:"
1807 $command "$netbox_root/manage.py" housekeeping
1814 [FILE:934:files/netbox_rq.sample.in]
1817 # This sample rc script starts the RQ worker background service which is
1818 # required for Webhooks and various automation tasks.
1821 # PROVIDE: netbox_rq
1825 # Add the following line to /etc/rc.conf.local or /etc/rc.conf
1826 # to enable netbox-rq:
1828 # netbox_rq_enable (bool): Set to NO by default.
1829 # Set it to YES to enable netbox_rq.
1834 rcvar=netbox_rq_enable
1836 load_rc_config $name
1838 start_cmd="netbox_rq_start"
1839 start_precmd="netbox_rq_precmd"
1840 command="%%PYTHON_CMD%%"
1841 command_args="%%PREFIX%%/share/netbox/manage.py rqworker"
1842 pidfile=${netbox_rq_pidfile:-/var/run/${name}/${name}.pid}
1843 netbox_rq_user=${netbox_rq_user:-www}
1848 install -d -o ${netbox_rq_user} `dirname ${pidfile}`
1853 echo "Starting netbox_rq."
1854 /usr/sbin/daemon -cf -p ${pidfile} -u ${netbox_rq_user} ${command} ${command_args}
1860 [FILE:3721:files/netboxrc.sample.in]
1863 # This sample rc script eliminate the need to use sysutils/py-supervisor to
1864 # run NetBox as a system service. Only www/py-gunicorn is needed as a WSGI.
1866 # Of course a working HTTP server like Apache/nginx is still required to make
1867 # use of the gunicorn WSGI.
1874 # Add the following line to /etc/rc.conf.local or /etc/rc.conf
1877 # netbox_enable (bool): Set to NO by default.
1878 # Set it to YES to enable netbox.
1879 # netbox_use_config (bool): Set to NO by default.
1880 # If set, read the configuration parameter from file defined in
1881 # "netbox_config" instead using rc variables.
1882 # netbox_config (str): Default to "/usr/local/etc/${name}.conf}"
1883 # Config file for gunicorn's netbox config file
1884 # netbox_command (str): Default to "%%LOCALBASE%%/bin/gunicorn"
1885 # Path to gunicorn to run netbox
1886 # netbox_bind (str): Default to "localhost:8001"
1887 # Interface and port to bind to
1888 # netbox_workers (int): Default to "5"
1889 # Number of gunicorn workers
1890 # netbox_threads (int): Default to "3"
1891 # Number of worker threads per handling request
1892 # netbox_timeout (int): Default to "120"
1893 # Worker timeout for gunicorn
1894 # netbox_max_requests (int): Default to "5000"
1895 # Maximum number of requests a worker process will process before respawning
1896 # netbox_max_requests_jitter (int): Default to "500"
1897 # Maximum number jitter to add to "netbox_max_requests"
1898 # netbox_extra_args (str): Not set by default
1899 # Extra arguments that are passed to gunicorn
1906 netbox_path=%%PREFIX%%/share/netbox
1907 extra_commands="upgrade"
1909 load_rc_config $name
1911 start_precmd="netbox_precmd"
1912 upgrade_cmd="netbox_upgrade"
1913 command=${netbox_program:-%%LOCALBASE%%/bin/gunicorn}
1914 procname=${netbox_procname:-%%PYTHON_CMD%%}
1915 netbox_chdir=${netbox_path}
1916 pidfile=${netbox_pidfile:-/var/run/${name}/${name}.pid}
1917 netbox_user=${netbox_user:-wwwraven}
1918 netbox_use_config=${netbox_use_config:-no}
1919 netbox_config=${netbox_config:-/${name}.conf}
1920 netbox_bind=${netbox_bind:-localhost:8001}
1921 netbox_workers=${netbox_workers:-5}
1922 netbox_threads=${netbox_threads:-3}
1923 netbox_timeout=${netbox_timeout:-120}
1924 netbox_max_requests=${netbox_max_requests:-5000}
1925 netbox_max_requests_jitter=${netbox_max_requests_jitter:-500}
1927 # Read settings from confguration file if set
1928 if checkyesno netbox_use_config && [ -f "${netbox_config}" ]; then
1929 command_args="${netbox_args} -D \
1930 --log-syslog --log-syslog-prefix ${name} \
1931 --log-syslog-to unix:///var/run/log#dgram \
1932 --disable-redirect-access-to-syslog \
1933 -p ${pidfile} --pythonpath ${netbox_path} \
1934 -c ${netbox_config} \
1937 command_args="${netbox_args} -D \
1938 --log-syslog --log-syslog-prefix ${name} \
1939 --log-syslog-to unix:///var/run/log#dgram \
1940 --disable-redirect-access-to-syslog \
1941 -p ${pidfile} --pythonpath ${netbox_path} \
1942 -b ${netbox_bind} -w ${netbox_workers} --threads ${netbox_threads} -t ${netbox_timeout} \
1943 --max-requests ${netbox_max_requests} --max-requests-jitter ${netbox_max_requests_jitter} \
1944 ${netbox_extra_args} \
1950 install -d -o ${netbox_user} `dirname ${pidfile}`
1955 if [ -f ${pidfile} ]; then
1957 %%PYTHON_CMD%% manage.py migrate
1958 %%PYTHON_CMD%% manage.py trace_paths --no-input
1959 %%LOCALBASE%%/bin/mkdocs build
1960 %%PYTHON_CMD%% manage.py collectstatic --no-input
1961 %%PYTHON_CMD%% manage.py remove_stale_contenttypes --no-input
1962 %%PYTHON_CMD%% manage.py clearsessions
1963 %%PYTHON_CMD%% manage.py clearcache
1964 echo "Please restart NetBox and the WSGI environment."
1966 echo "NetBox is not running!"
1973 [FILE:1152:files/pkg-message-primary.in]
1974 Please note that NetBox requires a PostgreSQL database server, which uses its
1975 built-in network address datatypes. Thus NetBox won't work with other RDBMS's,
1976 e.g. MySQL, MariaDB, etc.
1978 For installation instructions please refer to the related wiki page:
1980 - https://wiki.freebsd.org/Ports/net-mgmt/netbox
1986 As always it is strongly encouraged to make a backup of the database before the
1987 database migrations will be executed.
1989 The following steps are required to finish the upgrade:
1991 1. Run database migrations, trace any missing cable paths, build the embedded
1992 documentation, collect static files, remove stale content files, delete any
1993 expired user sessions and clear the cache.
1995 # cd %%PREXIX%%/share/netbox
1996 # python%%PYTHON_VER%% manage.py migrate
1997 # python%%PYTHON_VER%% manage.py trace_paths --no-input
1999 # python%%PYTHON_VER%% manage.py collectstatic --no-input
2000 # python%%PYTHON_VER%% manage.py remove_stale_contenttypes --no-input
2001 # python%%PYTHON_VER%% manage.py clearsessions
2002 # python%%PYTHON_VER%% manage.py clearcache
2004 2. Restart WSGI/httpd environment (supervisord/apache/nginx/etc.)