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.1
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 153524f5fc00aff1920ebe228bfbc285fdd60f3c6e5386673749e931a4f3ecba 7361978 netbox-community-netbox-3.4.1.tar.gz
149 [FILE:23249: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
349 share/netbox/extras/api/
352 nested_serializers.py
356 share/netbox/extras/forms/
366 share/netbox/extras/graphql/
371 share/netbox/extras/management/__init__.py
372 share/netbox/extras/management/commands/
383 share/netbox/extras/migrations/
385 0002_squashed_0059.py
386 0060_customlink_button_class.py
387 0061_extras_change_logging.py
388 0062_clear_secrets_changelog.py
389 0063_webhook_conditions.py
390 0064_configrevision.py
391 0065_imageattachment_change_logging.py
392 0066_customfield_name_validation.py
393 0067_customfield_min_max_values.py
394 0068_configcontext_cluster_types.py
395 0069_custom_object_field.py
396 0070_customlink_enabled.py
397 0071_standardize_id_fields.py
398 0072_created_datetimefield.py
399 0073_journalentry_tags_custom_fields.py
400 0074_customfield_extensions.py
401 0075_configcontext_locations.py
402 0076_tag_slug_unicode.py
403 0077_customlink_extend_text_and_url.py
404 0078_unique_constraints.py
405 0079_scheduled_jobs.py
406 0080_customlink_content_types.py
407 0081_exporttemplate_content_types.py
412 share/netbox/extras/models/
421 share/netbox/extras/plugins/
428 share/netbox/extras/tables/
432 share/netbox/extras/templatetags/
437 share/netbox/extras/tests/
443 test_customvalidator.py
452 share/netbox/extras/tests/dummy_plugin/
464 share/netbox/extras/tests/dummy_plugin/api/
468 share/netbox/extras/tests/dummy_plugin/migrations/
488 share/netbox/ipam/api/
490 nested_serializers.py
494 share/netbox/ipam/forms/
501 share/netbox/ipam/graphql/
507 share/netbox/ipam/management/__init__.py
508 share/netbox/ipam/management/commands/
511 share/netbox/ipam/migrations/
513 0002_squashed_0046.py
514 0047_prefix_depth_children.py
515 0048_prefix_populate_depth_children.py
516 0049_prefix_mark_utilized.py
518 0051_extend_tag_support.py
521 0054_vlangroup_min_max_vids.py
522 0055_servicetemplate.py
523 0056_standardize_id_fields.py
524 0057_created_datetimefield.py
525 0058_ipaddress_nat_inside_nonunique.py
527 0060_alter_l2vpn_slug.py
528 0061_fhrpgroup_name.py
529 0062_unique_constraints.py
530 0063_standardize_description_comments.py
532 share/netbox/ipam/models/
540 share/netbox/ipam/tables/
548 share/netbox/ipam/tests/
555 share/netbox/media/devicetype-images/.gitignore
556 share/netbox/media/image-attachments/.gitignore
561 configuration_example.py
562 configuration_testing.py
565 context_processors.py
576 share/netbox/netbox/api/
586 share/netbox/netbox/api/serializers/
592 share/netbox/netbox/api/viewsets/
595 share/netbox/netbox/config/
598 share/netbox/netbox/forms/
601 share/netbox/netbox/graphql/
609 share/netbox/netbox/models/
612 share/netbox/netbox/navigation/
615 share/netbox/netbox/search/
618 share/netbox/netbox/tables/
622 share/netbox/netbox/tests/
625 test_authentication.py
634 share/netbox/netbox/views/
638 share/netbox/netbox/views/generic/
646 share/netbox/project-static/
656 share/netbox/project-static/dist/
665 materialdesignicons-webfont-2ZY4X5WS.woff
666 materialdesignicons-webfont-DWVXV5L5.woff
667 materialdesignicons-webfont-EH3JD4GG.ttf
668 materialdesignicons-webfont-ER2MFQKM.woff2
669 materialdesignicons-webfont-KSYPMDN6.woff2
670 materialdesignicons-webfont-LWDVGUDX.eot
671 materialdesignicons-webfont-UHEFFMSX.eot
672 materialdesignicons-webfont-WM6M6ZHQ.ttf
682 share/netbox/project-static/docs/.info
683 share/netbox/project-static/img/
689 netbox_touch-icon-180.png
692 share/netbox/project-static/js/setmode.js
693 share/netbox/project-static/netbox-graphiql/
697 share/netbox/project-static/src/
713 share/netbox/project-static/src/buttons/
721 share/netbox/project-static/src/device/
725 share/netbox/project-static/src/forms/
731 share/netbox/project-static/src/select/
736 share/netbox/project-static/src/select/api/
741 share/netbox/project-static/src/state/index.ts
742 share/netbox/project-static/src/stores/
747 share/netbox/project-static/src/tables/
750 share/netbox/project-static/styles/
771 share/netbox/reports/__init__.py
772 share/netbox/scripts/__init__.py
773 share/netbox/templates/
783 share/netbox/templates/admin/index.html
784 share/netbox/templates/admin/extras/configrevision/restore.html
785 share/netbox/templates/base/
790 share/netbox/templates/circuits/
792 circuit_terminations_swap.html
793 circuittermination_edit.html
797 share/netbox/templates/circuits/inc/circuit_termination.html
798 share/netbox/templates/dcim/
803 component_create.html
804 connections_list.html
806 consoleport_delete.html
807 consoleserverport.html
808 consoleserverport_delete.html
812 device_import_child.html
815 devicebay_delete.html
816 devicebay_depopulate.html
817 devicebay_populate.html
822 interface_delete.html
825 inventoryitem_bulk_delete.html
826 inventoryitem_delete.html
827 inventoryitemrole.html
836 poweroutlet_delete.html
839 powerport_delete.html
842 rack_elevation_list.html
850 virtualchassis_add.html
851 virtualchassis_add_member.html
852 virtualchassis_edit.html
853 virtualchassis_remove_member.html
854 virtualdevicecontext.html
855 share/netbox/templates/dcim/device/
859 consoleserverports.html
870 share/netbox/templates/dcim/device/inc/interface_table_controls.html
871 share/netbox/templates/dcim/devicetype/
873 component_templates.html
874 share/netbox/templates/dcim/inc/
875 cable_termination.html
876 cable_toggle_buttons.html
877 connection_endpoints.html
878 device_import_header.html
879 endpoint_connection.html
880 interface_vlans_table.html
881 nonracked_devices.html
883 share/netbox/templates/dcim/inc/panels/inventory_items.html
884 share/netbox/templates/dcim/moduletype/
886 component_templates.html
887 share/netbox/templates/dcim/trace/
895 share/netbox/templates/exceptions/
897 permission_error.html
898 programming_error.html
899 share/netbox/templates/extras/
904 imageattachment_edit.html
906 object_changelog.html
907 object_configcontext.html
910 objectchange_list.html
920 share/netbox/templates/extras/admin/plugins_list.html
921 share/netbox/templates/extras/htmx/
924 share/netbox/templates/extras/inc/
925 configcontext_data.html
926 configcontext_format.html
929 share/netbox/templates/extras/templatetags/log_level.html
930 share/netbox/templates/generic/
931 bulk_add_component.html
937 confirmation_form.html
942 share/netbox/templates/htmx/
945 share/netbox/templates/inc/
949 missing_prerequisites.html
956 table_controls_htmx.html
958 share/netbox/templates/inc/panels/
962 image_attachments.html
965 share/netbox/templates/ipam/
970 fhrpgroupassignment_edit.html
972 ipaddress_assign.html
973 ipaddress_bulk_add.html
977 l2vpntermination.html
978 l2vpntermination_edit.html
992 share/netbox/templates/ipam/aggregate/
995 share/netbox/templates/ipam/inc/
996 ipaddress_edit_header.html
997 toggle_available.html
998 share/netbox/templates/ipam/inc/panels/fhrp_groups.html
999 share/netbox/templates/ipam/iprange/
1002 share/netbox/templates/ipam/prefix/
1007 share/netbox/templates/ipam/vlan/
1011 share/netbox/templates/rest_framework/api.html
1012 share/netbox/templates/tenancy/
1014 contactassignment_edit.html
1019 share/netbox/templates/users/
1026 share/netbox/templates/virtualization/
1028 cluster_add_devices.html
1032 virtualmachine_list.html
1034 share/netbox/templates/virtualization/cluster/
1037 virtual_machines.html
1038 share/netbox/templates/virtualization/virtualmachine/
1041 share/netbox/templates/wireless/
1043 wirelesslangroup.html
1045 wirelesslink_edit.html
1046 share/netbox/templates/wireless/inc/
1047 authentication_attrs.html
1048 wirelesslink_interface.html
1049 share/netbox/tenancy/
1057 share/netbox/tenancy/api/
1059 nested_serializers.py
1063 share/netbox/tenancy/forms/
1070 share/netbox/tenancy/graphql/
1074 share/netbox/tenancy/migrations/
1075 0001_squashed_0012.py
1076 0002_tenant_ordering.py
1078 0004_extend_tag_support.py
1079 0005_standardize_id_fields.py
1080 0006_created_datetimefield.py
1081 0007_contact_link.py
1082 0008_unique_constraints.py
1083 0009_standardize_description_comments.py
1085 share/netbox/tenancy/models/
1089 share/netbox/tenancy/tables/
1094 share/netbox/tenancy/tests/
1112 share/netbox/users/admin/
1117 share/netbox/users/api/
1119 nested_serializers.py
1123 share/netbox/users/graphql/
1127 share/netbox/users/migrations/
1128 0001_squashed_0011.py
1129 0002_standardize_id_fields.py
1130 0003_token_allowed_ips_last_used.py
1132 share/netbox/users/tests/
1138 share/netbox/utilities/
1143 custom_inspectors.py
1163 share/netbox/utilities/forms/
1169 share/netbox/utilities/forms/fields/
1176 share/netbox/utilities/management/__init__.py
1177 share/netbox/utilities/management/commands/
1181 share/netbox/utilities/serializers/json.py
1182 share/netbox/utilities/templates/builtins/
1185 customfield_value.html
1187 share/netbox/utilities/templates/buttons/
1196 share/netbox/utilities/templates/form_helpers/
1197 render_custom_fields.html
1201 share/netbox/utilities/templates/helpers/
1202 applied_filters.html
1203 table_config_form.html
1204 utilization_graph.html
1205 share/netbox/utilities/templates/navigation/menu.html
1206 share/netbox/utilities/templates/tabs/model_view_tabs.html
1207 share/netbox/utilities/templates/widgets/
1208 clearable_file_input.html
1209 colorselect_option.html
1210 select_duration.html
1212 select_option_with_pk.html
1215 share/netbox/utilities/templatetags/
1223 share/netbox/utilities/templatetags/builtins/
1227 share/netbox/utilities/testing/
1234 share/netbox/utilities/tests/
1243 share/netbox/virtualization/
1251 share/netbox/virtualization/api/
1253 nested_serializers.py
1257 share/netbox/virtualization/forms/
1265 share/netbox/virtualization/graphql/
1269 share/netbox/virtualization/migrations/
1270 0001_squashed_0022.py
1271 0023_virtualmachine_natural_ordering.py
1272 0024_cluster_relax_uniqueness.py
1273 0025_extend_tag_support.py
1274 0026_vminterface_bridge.py
1275 0027_standardize_id_fields.py
1276 0028_vminterface_vrf.py
1277 0029_created_datetimefield.py
1278 0030_cluster_status.py
1279 0031_virtualmachine_site_device.py
1280 0032_virtualmachine_update_sites.py
1281 0033_unique_constraints.py
1282 0034_standardize_description_comments.py
1284 share/netbox/virtualization/models/
1288 share/netbox/virtualization/tables/
1292 share/netbox/virtualization/tests/
1298 share/netbox/wireless/
1310 share/netbox/wireless/api/
1312 nested_serializers.py
1316 share/netbox/wireless/forms/
1322 share/netbox/wireless/graphql/
1326 share/netbox/wireless/migrations/
1328 0002_standardize_id_fields.py
1329 0003_created_datetimefield.py
1330 0004_wireless_tenancy.py
1331 0005_wirelesslink_interface_types.py
1332 0006_unique_constraints.py
1333 0007_standardize_description_comments.py
1334 0008_wirelesslan_status.py
1336 share/netbox/wireless/tables/
1340 share/netbox/wireless/tests/
1347 [FILE:4976:manifests/plist.docs]
1348 share/netbox/docs/docs/
1354 share/netbox/docs/docs/_theme/main.html
1355 share/netbox/docs/docs/administration/
1360 replicating-netbox.md
1361 share/netbox/docs/docs/administration/authentication/
1362 microsoft-azure-ad.md
1365 share/netbox/docs/docs/configuration/
1375 remote-authentication.md
1376 required-parameters.md
1379 share/netbox/docs/docs/customization/
1383 custom-validation.md
1386 share/netbox/docs/docs/development/
1388 application-registry.md
1394 release-checklist.md
1400 share/netbox/docs/docs/features/
1402 authentication-permissions.md
1419 share/netbox/docs/docs/getting-started/
1422 share/netbox/docs/docs/installation/
1431 share/netbox/docs/docs/integrations/
1434 prometheus-metrics.md
1437 share/netbox/docs/docs/media/
1438 admin_ui_run_permission.png
1439 power_distribution.png
1440 share/netbox/docs/docs/media/authentication/
1441 azure_ad_add_app_registration.png
1442 azure_ad_add_client_secret.png
1443 azure_ad_app_registration.png
1444 azure_ad_app_registration_created.png
1445 azure_ad_client_secret.png
1446 azure_ad_client_secret_created.png
1447 azure_ad_login_portal.png
1448 netbox_azure_ad_login.png
1449 netbox_okta_login.png
1450 okta_create_app_registration.png
1451 okta_integration_parameters.png
1452 okta_login_portal.png
1453 okta_web_app_integration.png
1454 share/netbox/docs/docs/media/development/
1456 github_fork_button.png
1457 github_fork_dialog.png
1458 github_new_issue.png
1459 share/netbox/docs/docs/media/installation/
1460 netbox_application_stack.png
1462 share/netbox/docs/docs/media/models/dcim_cable_trace.png
1463 share/netbox/docs/docs/media/release-notes/netbox30_ui.png
1464 share/netbox/docs/docs/media/screenshots/
1470 share/netbox/docs/docs/models/circuits/
1472 circuittermination.md
1476 share/netbox/docs/docs/models/dcim/
1479 consoleporttemplate.md
1480 consoleserverport.md
1481 consoleserverporttemplate.md
1484 devicebaytemplate.md
1488 frontporttemplate.md
1490 interfacetemplate.md
1492 inventoryitemrole.md
1493 inventoryitemtemplate.md
1498 modulebaytemplate.md
1503 poweroutlettemplate.md
1506 powerporttemplate.md
1516 virtualdevicecontext.md
1517 share/netbox/docs/docs/models/extras/
1529 share/netbox/docs/docs/models/ipam/
1533 fhrpgroupassignment.md
1547 share/netbox/docs/docs/models/tenancy/
1553 share/netbox/docs/docs/models/virtualization/
1559 share/netbox/docs/docs/models/wireless/
1563 share/netbox/docs/docs/plugins/index.md
1564 share/netbox/docs/docs/plugins/development/
1579 share/netbox/docs/docs/reference/
1583 share/netbox/docs/docs/release-notes/
1604 [FILE:155:manifests/plist.examples]
1605 share/examples/netbox/
1609 share/examples/netbox/bsd/
1610 850.netbox-housekeeping.sample
1615 [FILE:612:patches/patch-mkdocs.yml]
1616 --- mkdocs.yml.orig 2022-04-28 19:00:11 UTC
1618 @@ -1,5 +1,5 @@ site_name: NetBox Documentation
1619 site_name: NetBox Documentation
1620 -site_dir: netbox/project-static/docs
1621 +site_dir: project-static/docs
1622 site_url: https://docs.netbox.dev/
1623 repo_name: netbox-community/netbox
1624 repo_url: https://github.com/netbox-community/netbox
1625 @@ -26,7 +26,6 @@ plugins:
1629 - - os.chdir('netbox/')
1630 - os.environ.setdefault("DJANGO_SETTINGS_MODULE", "netbox.settings")
1635 [FILE:789:files/850.netbox-housekeeping.sample.in]
1637 # This shell script invokes NetBox's housekeeping management command, which
1638 # intended to be run nightly.
1640 # If you want to enable this script, copy it to %%PREFIX%%/etc/periodic/daily
1641 # and place the following into /etc/periodic.conf:
1643 # daily_netbox_housekeeping_enable="YES"
1645 # If NetBox has been installed into a nonstandard location, update the paths
1647 command="%%PYTHON_CMD%%"
1648 netbox_root="%%PREFIX%%/share/netbox"
1650 # If there is a global system configuration file, suck it in.
1652 if [ -r /etc/defaults/periodic.conf ]; then
1653 . /etc/defaults/periodic.conf
1654 source_periodic_confs
1659 case "$daily_netbox_housekeeping_enable" in
1662 echo "Running NetBox housekeeping:"
1663 $command "$netbox_root/manage.py" housekeeping
1670 [FILE:934:files/netbox_rq.sample.in]
1673 # This sample rc script starts the RQ worker background service which is
1674 # required for Webhooks and various automation tasks.
1677 # PROVIDE: netbox_rq
1681 # Add the following line to /etc/rc.conf.local or /etc/rc.conf
1682 # to enable netbox-rq:
1684 # netbox_rq_enable (bool): Set to NO by default.
1685 # Set it to YES to enable netbox_rq.
1690 rcvar=netbox_rq_enable
1692 load_rc_config $name
1694 start_cmd="netbox_rq_start"
1695 start_precmd="netbox_rq_precmd"
1696 command="%%PYTHON_CMD%%"
1697 command_args="%%PREFIX%%/share/netbox/manage.py rqworker"
1698 pidfile=${netbox_rq_pidfile:-/var/run/${name}/${name}.pid}
1699 netbox_rq_user=${netbox_rq_user:-www}
1704 install -d -o ${netbox_rq_user} `dirname ${pidfile}`
1709 echo "Starting netbox_rq."
1710 /usr/sbin/daemon -cf -p ${pidfile} -u ${netbox_rq_user} ${command} ${command_args}
1716 [FILE:3721:files/netboxrc.sample.in]
1719 # This sample rc script eliminate the need to use sysutils/py-supervisor to
1720 # run NetBox as a system service. Only www/py-gunicorn is needed as a WSGI.
1722 # Of course a working HTTP server like Apache/nginx is still required to make
1723 # use of the gunicorn WSGI.
1730 # Add the following line to /etc/rc.conf.local or /etc/rc.conf
1733 # netbox_enable (bool): Set to NO by default.
1734 # Set it to YES to enable netbox.
1735 # netbox_use_config (bool): Set to NO by default.
1736 # If set, read the configuration parameter from file defined in
1737 # "netbox_config" instead using rc variables.
1738 # netbox_config (str): Default to "/usr/local/etc/${name}.conf}"
1739 # Config file for gunicorn's netbox config file
1740 # netbox_command (str): Default to "%%LOCALBASE%%/bin/gunicorn"
1741 # Path to gunicorn to run netbox
1742 # netbox_bind (str): Default to "localhost:8001"
1743 # Interface and port to bind to
1744 # netbox_workers (int): Default to "5"
1745 # Number of gunicorn workers
1746 # netbox_threads (int): Default to "3"
1747 # Number of worker threads per handling request
1748 # netbox_timeout (int): Default to "120"
1749 # Worker timeout for gunicorn
1750 # netbox_max_requests (int): Default to "5000"
1751 # Maximum number of requests a worker process will process before respawning
1752 # netbox_max_requests_jitter (int): Default to "500"
1753 # Maximum number jitter to add to "netbox_max_requests"
1754 # netbox_extra_args (str): Not set by default
1755 # Extra arguments that are passed to gunicorn
1762 netbox_path=%%PREFIX%%/share/netbox
1763 extra_commands="upgrade"
1765 load_rc_config $name
1767 start_precmd="netbox_precmd"
1768 upgrade_cmd="netbox_upgrade"
1769 command=${netbox_program:-%%LOCALBASE%%/bin/gunicorn}
1770 procname=${netbox_procname:-%%PYTHON_CMD%%}
1771 netbox_chdir=${netbox_path}
1772 pidfile=${netbox_pidfile:-/var/run/${name}/${name}.pid}
1773 netbox_user=${netbox_user:-wwwraven}
1774 netbox_use_config=${netbox_use_config:-no}
1775 netbox_config=${netbox_config:-/${name}.conf}
1776 netbox_bind=${netbox_bind:-localhost:8001}
1777 netbox_workers=${netbox_workers:-5}
1778 netbox_threads=${netbox_threads:-3}
1779 netbox_timeout=${netbox_timeout:-120}
1780 netbox_max_requests=${netbox_max_requests:-5000}
1781 netbox_max_requests_jitter=${netbox_max_requests_jitter:-500}
1783 # Read settings from confguration file if set
1784 if checkyesno netbox_use_config && [ -f "${netbox_config}" ]; then
1785 command_args="${netbox_args} -D \
1786 --log-syslog --log-syslog-prefix ${name} \
1787 --log-syslog-to unix:///var/run/log#dgram \
1788 --disable-redirect-access-to-syslog \
1789 -p ${pidfile} --pythonpath ${netbox_path} \
1790 -c ${netbox_config} \
1793 command_args="${netbox_args} -D \
1794 --log-syslog --log-syslog-prefix ${name} \
1795 --log-syslog-to unix:///var/run/log#dgram \
1796 --disable-redirect-access-to-syslog \
1797 -p ${pidfile} --pythonpath ${netbox_path} \
1798 -b ${netbox_bind} -w ${netbox_workers} --threads ${netbox_threads} -t ${netbox_timeout} \
1799 --max-requests ${netbox_max_requests} --max-requests-jitter ${netbox_max_requests_jitter} \
1800 ${netbox_extra_args} \
1806 install -d -o ${netbox_user} `dirname ${pidfile}`
1811 if [ -f ${pidfile} ]; then
1813 %%PYTHON_CMD%% manage.py migrate
1814 %%PYTHON_CMD%% manage.py trace_paths --no-input
1815 %%LOCALBASE%%/bin/mkdocs build
1816 %%PYTHON_CMD%% manage.py collectstatic --no-input
1817 %%PYTHON_CMD%% manage.py remove_stale_contenttypes --no-input
1818 %%PYTHON_CMD%% manage.py clearsessions
1819 %%PYTHON_CMD%% manage.py clearcache
1820 echo "Please restart NetBox and the WSGI environment."
1822 echo "NetBox is not running!"
1829 [FILE:1152:files/pkg-message-primary.in]
1830 Please note that NetBox requires a PostgreSQL database server, which uses its
1831 built-in network address datatypes. Thus NetBox won't work with other RDBMS's,
1832 e.g. MySQL, MariaDB, etc.
1834 For installation instructions please refer to the related wiki page:
1836 - https://wiki.freebsd.org/Ports/net-mgmt/netbox
1842 As always it is strongly encouraged to make a backup of the database before the
1843 database migrations will be executed.
1845 The following steps are required to finish the upgrade:
1847 1. Run database migrations, trace any missing cable paths, build the embedded
1848 documentation, collect static files, remove stale content files, delete any
1849 expired user sessions and clear the cache.
1851 # cd %%PREXIX%%/share/netbox
1852 # python%%PYTHON_VER%% manage.py migrate
1853 # python%%PYTHON_VER%% manage.py trace_paths --no-input
1855 # python%%PYTHON_VER%% manage.py collectstatic --no-input
1856 # python%%PYTHON_VER%% manage.py remove_stale_contenttypes --no-input
1857 # python%%PYTHON_VER%% manage.py clearsessions
1858 # python%%PYTHON_VER%% manage.py clearcache
1860 2. Restart WSGI/httpd environment (supervisord/apache/nginx/etc.)