2020-02-26 17:40:31 +01:00
|
|
|
site_name: NetBox Documentation
|
|
|
|
|
site_url: https://netbox.readthedocs.io/
|
2019-07-09 17:36:39 +02:00
|
|
|
repo_url: https://github.com/netbox-community/netbox
|
2020-03-05 16:47:12 +01:00
|
|
|
python:
|
|
|
|
|
install:
|
|
|
|
|
- requirements: docs/requirements.txt
|
2020-02-26 17:40:31 +01:00
|
|
|
theme:
|
2021-02-25 03:21:17 +01:00
|
|
|
name: material
|
2020-03-26 16:54:58 +01:00
|
|
|
extra_css:
|
|
|
|
|
- extra.css
|
2020-02-26 17:40:31 +01:00
|
|
|
markdown_extensions:
|
2021-02-25 03:21:17 +01:00
|
|
|
- admonition
|
2020-03-05 16:47:12 +01:00
|
|
|
- markdown_include.include:
|
|
|
|
|
headingOffset: 1
|
2021-04-02 22:29:01 +02:00
|
|
|
- pymdownx.emoji:
|
|
|
|
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
|
|
|
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
2021-02-25 03:21:17 +01:00
|
|
|
- pymdownx.superfences
|
|
|
|
|
- pymdownx.tabbed
|
2020-02-26 17:40:31 +01:00
|
|
|
nav:
|
2018-07-17 23:23:10 +02:00
|
|
|
- Introduction: 'index.md'
|
|
|
|
|
- Installation:
|
|
|
|
|
- Installing NetBox: 'installation/index.md'
|
|
|
|
|
- 1. PostgreSQL: 'installation/1-postgresql.md'
|
2020-02-26 17:40:31 +01:00
|
|
|
- 2. Redis: 'installation/2-redis.md'
|
|
|
|
|
- 3. NetBox: 'installation/3-netbox.md'
|
2020-07-20 22:53:04 +02: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 23:23:10 +02:00
|
|
|
- Upgrading NetBox: 'installation/upgrading.md'
|
2020-01-21 15:41:55 +01:00
|
|
|
- Migrating to systemd: 'installation/migrating-to-systemd.md'
|
2018-07-17 23:23:10 +02:00
|
|
|
- Configuration:
|
|
|
|
|
- Configuring NetBox: 'configuration/index.md'
|
|
|
|
|
- Required Settings: 'configuration/required-settings.md'
|
|
|
|
|
- Optional Settings: 'configuration/optional-settings.md'
|
|
|
|
|
- Core Functionality:
|
|
|
|
|
- IP Address Management: 'core-functionality/ipam.md'
|
2020-03-05 23:03:03 +01:00
|
|
|
- VLAN Management: 'core-functionality/vlans.md'
|
2018-07-17 23:23:10 +02:00
|
|
|
- Sites and Racks: 'core-functionality/sites-and-racks.md'
|
2020-03-05 23:03:03 +01:00
|
|
|
- Devices and Cabling: 'core-functionality/devices.md'
|
2020-03-05 22:26:23 +01:00
|
|
|
- Device Types: 'core-functionality/device-types.md'
|
2020-03-05 23:03:03 +01:00
|
|
|
- Virtualization: 'core-functionality/virtualization.md'
|
|
|
|
|
- Service Mapping: 'core-functionality/services.md'
|
2018-07-17 23:23:10 +02:00
|
|
|
- Circuits: 'core-functionality/circuits.md'
|
2020-03-05 23:03:03 +01:00
|
|
|
- Power Tracking: 'core-functionality/power.md'
|
2018-07-17 23:23:10 +02:00
|
|
|
- Secrets: 'core-functionality/secrets.md'
|
2020-07-30 19:02:53 +02:00
|
|
|
- Tenancy: 'core-functionality/tenancy.md'
|
2018-07-17 23:23:10 +02:00
|
|
|
- Additional Features:
|
2019-09-20 15:10:32 +02:00
|
|
|
- Caching: 'additional-features/caching.md'
|
|
|
|
|
- Change Logging: 'additional-features/change-logging.md'
|
2020-07-30 17:36:46 +02:00
|
|
|
- Context Data: 'models/extras/configcontext.md'
|
2019-09-20 15:10:32 +02:00
|
|
|
- Custom Fields: 'additional-features/custom-fields.md'
|
2019-12-06 03:07:43 +01:00
|
|
|
- Custom Links: 'additional-features/custom-links.md'
|
2019-09-20 15:10:32 +02:00
|
|
|
- Custom Scripts: 'additional-features/custom-scripts.md'
|
2018-07-17 23:23:10 +02:00
|
|
|
- Export Templates: 'additional-features/export-templates.md'
|
2021-03-29 15:59:44 +02:00
|
|
|
- Journaling: 'additional-features/journaling.md'
|
2020-01-08 16:54:09 +01:00
|
|
|
- NAPALM: 'additional-features/napalm.md'
|
2019-09-20 15:10:32 +02:00
|
|
|
- Prometheus Metrics: 'additional-features/prometheus-metrics.md'
|
2018-07-17 23:23:10 +02:00
|
|
|
- Reports: 'additional-features/reports.md'
|
2020-07-30 17:36:46 +02:00
|
|
|
- Tags: 'models/extras/tag.md'
|
2018-07-17 23:23:10 +02:00
|
|
|
- Webhooks: 'additional-features/webhooks.md'
|
2020-03-20 17:20:25 +01:00
|
|
|
- Plugins:
|
|
|
|
|
- Using Plugins: 'plugins/index.md'
|
|
|
|
|
- Developing Plugins: 'plugins/development.md'
|
2018-07-20 21:26:01 +02:00
|
|
|
- Administration:
|
2020-06-01 21:28:36 +02:00
|
|
|
- Permissions: 'administration/permissions.md'
|
2018-07-20 21:26:01 +02:00
|
|
|
- Replicating NetBox: 'administration/replicating-netbox.md'
|
2018-12-04 15:19:32 +01:00
|
|
|
- NetBox Shell: 'administration/netbox-shell.md'
|
2020-08-04 23:07:45 +02:00
|
|
|
- REST API:
|
|
|
|
|
- Overview: 'rest-api/overview.md'
|
|
|
|
|
- Filtering: 'rest-api/filtering.md'
|
|
|
|
|
- Authentication: 'rest-api/authentication.md'
|
|
|
|
|
- Working with Secrets: 'rest-api/working-with-secrets.md'
|
2018-07-17 23:23:10 +02:00
|
|
|
- Development:
|
2018-07-27 19:42:18 +02:00
|
|
|
- Introduction: 'development/index.md'
|
2020-11-18 17:25:31 +01:00
|
|
|
- Getting Started: 'development/getting-started.md'
|
2018-11-12 20:36:09 +01:00
|
|
|
- Style Guide: 'development/style-guide.md'
|
2021-04-02 22:29:01 +02:00
|
|
|
- Models: 'development/models.md'
|
2018-11-12 19:59:58 +01:00
|
|
|
- Extending Models: 'development/extending-models.md'
|
2020-03-30 21:31:13 +02:00
|
|
|
- Application Registry: 'development/application-registry.md'
|
2020-04-24 15:23:58 +02:00
|
|
|
- User Preferences: 'development/user-preferences.md'
|
2018-08-02 17:53:31 +02:00
|
|
|
- Release Checklist: 'development/release-checklist.md'
|
2019-10-10 18:02:53 +02:00
|
|
|
- Release Notes:
|
2021-03-31 20:24:43 +02:00
|
|
|
- Version 2.11: 'release-notes/version-2.11.md'
|
2020-11-17 20:11:47 +01:00
|
|
|
- Version 2.10: 'release-notes/version-2.10.md'
|
2020-09-04 22:09:05 +02:00
|
|
|
- Version 2.9: 'release-notes/version-2.9.md'
|
2020-03-04 20:33:55 +01:00
|
|
|
- Version 2.8: 'release-notes/version-2.8.md'
|
2020-01-16 18:57:24 +01:00
|
|
|
- Version 2.7: 'release-notes/version-2.7.md'
|
2019-10-10 18:02:53 +02: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'
|
