2020-02-26 11:40:31 -05:00
|
|
|
site_name: NetBox Documentation
|
2021-07-19 14:18:08 -04:00
|
|
|
site_dir: netbox/project-static/docs
|
2020-02-26 11:40:31 -05:00
|
|
|
site_url: https://netbox.readthedocs.io/
|
2021-07-28 15:07:46 -04:00
|
|
|
repo_name: netbox-community/netbox
|
2019-07-09 11:36:39 -04:00
|
|
|
repo_url: https://github.com/netbox-community/netbox
|
2020-02-26 11:40:31 -05:00
|
|
|
theme:
|
2021-02-24 21:21:17 -05:00
|
|
|
name: material
|
2021-07-28 16:26:04 -04:00
|
|
|
icon:
|
|
|
|
|
repo: fontawesome/brands/github
|
2021-04-26 01:16:23 -07:00
|
|
|
palette:
|
|
|
|
|
- scheme: default
|
|
|
|
|
toggle:
|
|
|
|
|
icon: material/lightbulb-outline
|
|
|
|
|
name: Switch to Dark Mode
|
|
|
|
|
- scheme: slate
|
|
|
|
|
toggle:
|
|
|
|
|
icon: material/lightbulb
|
|
|
|
|
name: Switch to Light Mode
|
2022-01-19 16:44:18 -05:00
|
|
|
plugins:
|
|
|
|
|
- mkdocstrings:
|
|
|
|
|
handlers:
|
|
|
|
|
python:
|
|
|
|
|
setup_commands:
|
|
|
|
|
- import os
|
|
|
|
|
- import django
|
2022-01-20 09:27:37 -05:00
|
|
|
- os.chdir('netbox/')
|
2022-01-19 16:44:18 -05:00
|
|
|
- os.environ.setdefault("DJANGO_SETTINGS_MODULE", "netbox.settings")
|
|
|
|
|
- django.setup()
|
|
|
|
|
rendering:
|
2022-01-20 10:53:00 -05:00
|
|
|
heading_level: 3
|
2022-01-21 14:41:37 -05:00
|
|
|
members_order: source
|
2022-01-19 16:44:18 -05:00
|
|
|
show_root_heading: true
|
|
|
|
|
show_root_full_path: false
|
|
|
|
|
show_root_toc_entry: false
|
2021-04-26 01:16:23 -07:00
|
|
|
extra:
|
|
|
|
|
social:
|
|
|
|
|
- icon: fontawesome/brands/github
|
|
|
|
|
link: https://github.com/netbox-community/netbox
|
|
|
|
|
- icon: fontawesome/brands/slack
|
2021-09-15 11:46:58 -04:00
|
|
|
link: https://netdev.chat/
|
2020-03-26 11:54:58 -04:00
|
|
|
extra_css:
|
|
|
|
|
- extra.css
|
2020-02-26 11:40:31 -05:00
|
|
|
markdown_extensions:
|
2021-02-24 21:21:17 -05:00
|
|
|
- admonition
|
2021-07-28 15:12:17 -04:00
|
|
|
- attr_list
|
2020-03-05 10:47:12 -05:00
|
|
|
- markdown_include.include:
|
2021-09-15 11:46:58 -04:00
|
|
|
base_path: 'docs/'
|
2020-03-05 10:47:12 -05:00
|
|
|
headingOffset: 1
|
2021-04-02 16:29:01 -04:00
|
|
|
- pymdownx.emoji:
|
|
|
|
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
|
|
|
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
2021-02-24 21:21:17 -05:00
|
|
|
- pymdownx.superfences
|
|
|
|
|
- pymdownx.tabbed
|
2020-02-26 11:40:31 -05:00
|
|
|
nav:
|
2018-07-17 17:23:10 -04:00
|
|
|
- Introduction: 'index.md'
|
|
|
|
|
- Installation:
|
|
|
|
|
- Installing NetBox: 'installation/index.md'
|
|
|
|
|
- 1. PostgreSQL: 'installation/1-postgresql.md'
|
2020-02-26 11:40:31 -05:00
|
|
|
- 2. Redis: 'installation/2-redis.md'
|
|
|
|
|
- 3. NetBox: 'installation/3-netbox.md'
|
2020-07-20 16:53:04 -04:00
|
|
|
- 4. Gunicorn: 'installation/4-gunicorn.md'
|
|
|
|
|
- 5. HTTP Server: 'installation/5-http-server.md'
|
|
|
|
|
- 6. LDAP (Optional): 'installation/6-ldap.md'
|
2018-07-17 17:23:10 -04:00
|
|
|
- Upgrading NetBox: 'installation/upgrading.md'
|
2020-01-21 09:41:55 -05:00
|
|
|
- Migrating to systemd: 'installation/migrating-to-systemd.md'
|
2018-07-17 17:23:10 -04:00
|
|
|
- Configuration:
|
|
|
|
|
- Configuring NetBox: 'configuration/index.md'
|
|
|
|
|
- Required Settings: 'configuration/required-settings.md'
|
|
|
|
|
- Optional Settings: 'configuration/optional-settings.md'
|
2021-10-26 15:40:34 -04:00
|
|
|
- Dynamic Settings: 'configuration/dynamic-settings.md'
|
2021-11-04 15:41:46 -04:00
|
|
|
- Remote Authentication: 'configuration/remote-authentication.md'
|
2018-07-17 17:23:10 -04:00
|
|
|
- Core Functionality:
|
|
|
|
|
- IP Address Management: 'core-functionality/ipam.md'
|
2020-03-05 17:03:03 -05:00
|
|
|
- VLAN Management: 'core-functionality/vlans.md'
|
2018-07-17 17:23:10 -04:00
|
|
|
- Sites and Racks: 'core-functionality/sites-and-racks.md'
|
2020-03-05 17:03:03 -05:00
|
|
|
- Devices and Cabling: 'core-functionality/devices.md'
|
2020-03-05 16:26:23 -05:00
|
|
|
- Device Types: 'core-functionality/device-types.md'
|
2021-12-20 10:31:18 -05:00
|
|
|
- Modules: 'core-functionality/modules.md'
|
2020-03-05 17:03:03 -05:00
|
|
|
- Virtualization: 'core-functionality/virtualization.md'
|
|
|
|
|
- Service Mapping: 'core-functionality/services.md'
|
2018-07-17 17:23:10 -04:00
|
|
|
- Circuits: 'core-functionality/circuits.md'
|
2021-10-20 11:22:56 -04:00
|
|
|
- Wireless: 'core-functionality/wireless.md'
|
2020-03-05 17:03:03 -05:00
|
|
|
- Power Tracking: 'core-functionality/power.md'
|
2020-07-30 13:02:53 -04:00
|
|
|
- Tenancy: 'core-functionality/tenancy.md'
|
2021-10-18 16:20:31 -04:00
|
|
|
- Contacts: 'core-functionality/contacts.md'
|
2021-06-24 08:37:06 -04:00
|
|
|
- Customization:
|
|
|
|
|
- Custom Fields: 'customization/custom-fields.md'
|
|
|
|
|
- Custom Validation: 'customization/custom-validation.md'
|
2021-10-19 15:31:07 -04:00
|
|
|
- Custom Links: 'models/extras/customlink.md'
|
2021-06-24 08:37:06 -04:00
|
|
|
- Export Templates: 'customization/export-templates.md'
|
|
|
|
|
- Custom Scripts: 'customization/custom-scripts.md'
|
|
|
|
|
- Reports: 'customization/reports.md'
|
2018-07-17 17:23:10 -04:00
|
|
|
- Additional Features:
|
2019-09-20 09:10:32 -04:00
|
|
|
- Change Logging: 'additional-features/change-logging.md'
|
2020-07-30 11:36:46 -04:00
|
|
|
- Context Data: 'models/extras/configcontext.md'
|
2021-03-29 09:59:44 -04:00
|
|
|
- Journaling: 'additional-features/journaling.md'
|
2020-01-08 15:54:09 +00:00
|
|
|
- NAPALM: 'additional-features/napalm.md'
|
2019-09-20 09:10:32 -04:00
|
|
|
- Prometheus Metrics: 'additional-features/prometheus-metrics.md'
|
2020-07-30 11:36:46 -04:00
|
|
|
- Tags: 'models/extras/tag.md'
|
2018-07-17 17:23:10 -04:00
|
|
|
- Webhooks: 'additional-features/webhooks.md'
|
2020-03-20 12:20:25 -04:00
|
|
|
- Plugins:
|
|
|
|
|
- Using Plugins: 'plugins/index.md'
|
2022-01-19 16:44:18 -05:00
|
|
|
- Developing Plugins:
|
2022-01-25 13:53:31 -05:00
|
|
|
- Getting Started: 'plugins/development/index.md'
|
2022-01-27 16:14:02 -05:00
|
|
|
- Models: 'plugins/development/models.md'
|
2022-01-25 13:53:31 -05:00
|
|
|
- Views: 'plugins/development/views.md'
|
2022-01-27 16:14:02 -05:00
|
|
|
- Tables: 'plugins/development/tables.md'
|
|
|
|
|
- Filter Sets: 'plugins/development/filtersets.md'
|
2022-01-25 13:53:31 -05:00
|
|
|
- REST API: 'plugins/development/rest-api.md'
|
|
|
|
|
- Background Tasks: 'plugins/development/background-tasks.md'
|
2018-07-20 15:26:01 -04:00
|
|
|
- Administration:
|
2021-11-02 11:49:10 -04:00
|
|
|
- Authentication: 'administration/authentication.md'
|
2020-06-01 15:28:36 -04:00
|
|
|
- Permissions: 'administration/permissions.md'
|
2021-06-11 10:44:17 -04:00
|
|
|
- Housekeeping: 'administration/housekeeping.md'
|
2018-07-20 15:26:01 -04:00
|
|
|
- Replicating NetBox: 'administration/replicating-netbox.md'
|
2018-12-04 09:19:32 -05:00
|
|
|
- NetBox Shell: 'administration/netbox-shell.md'
|
2020-08-04 17:07:45 -04:00
|
|
|
- REST API:
|
|
|
|
|
- Overview: 'rest-api/overview.md'
|
|
|
|
|
- Filtering: 'rest-api/filtering.md'
|
|
|
|
|
- Authentication: 'rest-api/authentication.md'
|
2021-06-30 09:35:50 -04:00
|
|
|
- GraphQL API:
|
|
|
|
|
- Overview: 'graphql-api/overview.md'
|
2021-10-25 09:52:08 -04:00
|
|
|
- Reference:
|
|
|
|
|
- Conditions: 'reference/conditions.md'
|
2018-07-17 17:23:10 -04:00
|
|
|
- Development:
|
2018-07-27 13:42:18 -04:00
|
|
|
- Introduction: 'development/index.md'
|
2020-11-18 11:25:31 -05:00
|
|
|
- Getting Started: 'development/getting-started.md'
|
2018-11-12 14:36:09 -05:00
|
|
|
- Style Guide: 'development/style-guide.md'
|
2021-04-02 16:29:01 -04:00
|
|
|
- Models: 'development/models.md'
|
2021-07-23 13:43:33 -04:00
|
|
|
- Adding Models: 'development/adding-models.md'
|
2018-11-12 13:59:58 -05:00
|
|
|
- Extending Models: 'development/extending-models.md'
|
2021-06-09 11:39:44 -04:00
|
|
|
- Signals: 'development/signals.md'
|
2020-03-30 15:31:13 -04:00
|
|
|
- Application Registry: 'development/application-registry.md'
|
2020-04-24 09:23:58 -04:00
|
|
|
- User Preferences: 'development/user-preferences.md'
|
2021-08-24 00:30:04 -07:00
|
|
|
- Web UI: 'development/web-ui.md'
|
2018-08-02 11:53:31 -04:00
|
|
|
- Release Checklist: 'development/release-checklist.md'
|
2019-10-10 12:02:53 -04:00
|
|
|
- Release Notes:
|
2021-11-03 11:47:11 -04:00
|
|
|
- Summary: 'release-notes/index.md'
|
|
|
|
|
- Version 3.1: 'release-notes/version-3.1.md'
|
2021-06-09 13:20:46 -04:00
|
|
|
- Version 3.0: 'release-notes/version-3.0.md'
|
2021-03-31 14:24:43 -04:00
|
|
|
- Version 2.11: 'release-notes/version-2.11.md'
|
2020-11-17 14:11:47 -05:00
|
|
|
- Version 2.10: 'release-notes/version-2.10.md'
|
2020-09-04 16:09:05 -04:00
|
|
|
- Version 2.9: 'release-notes/version-2.9.md'
|
2020-03-04 14:33:55 -05:00
|
|
|
- Version 2.8: 'release-notes/version-2.8.md'
|
2020-01-16 12:57:24 -05:00
|
|
|
- Version 2.7: 'release-notes/version-2.7.md'
|
2019-10-10 12:02:53 -04:00
|
|
|
- Version 2.6: 'release-notes/version-2.6.md'
|
|
|
|
|
- Version 2.5: 'release-notes/version-2.5.md'
|
|
|
|
|
- Version 2.4: 'release-notes/version-2.4.md'
|
|
|
|
|
- Version 2.3: 'release-notes/version-2.3.md'
|
|
|
|
|
- Version 2.2: 'release-notes/version-2.2.md'
|
|
|
|
|
- Version 2.1: 'release-notes/version-2.1.md'
|
|
|
|
|
- Version 2.0: 'release-notes/version-2.0.md'
|
