2020-02-26 11:40:31 -05:00
|
|
|
site_name: NetBox Documentation
|
|
|
|
|
site_url: https://netbox.readthedocs.io/
|
2019-07-09 11:36:39 -04:00
|
|
|
repo_url: https://github.com/netbox-community/netbox
|
2020-03-05 10:47:12 -05:00
|
|
|
python:
|
|
|
|
|
install:
|
|
|
|
|
- requirements: docs/requirements.txt
|
2020-02-26 11:40:31 -05:00
|
|
|
theme:
|
|
|
|
|
name: readthedocs
|
|
|
|
|
navigation_depth: 3
|
2020-03-26 11:54:58 -04:00
|
|
|
extra_css:
|
|
|
|
|
- extra.css
|
2020-02-26 11:40:31 -05:00
|
|
|
markdown_extensions:
|
|
|
|
|
- admonition:
|
2020-03-05 10:47:12 -05:00
|
|
|
- markdown_include.include:
|
|
|
|
|
headingOffset: 1
|
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'
|
|
|
|
|
- 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'
|
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'
|
2020-03-05 17:03:03 -05:00
|
|
|
- Power Tracking: 'core-functionality/power.md'
|
2018-07-17 17:23:10 -04:00
|
|
|
- Secrets: 'core-functionality/secrets.md'
|
2020-03-05 17:03:03 -05:00
|
|
|
- Tenancy Assignment: 'core-functionality/tenancy.md'
|
2018-07-17 17:23:10 -04:00
|
|
|
- Additional Features:
|
2019-09-20 09:10:32 -04:00
|
|
|
- Caching: 'additional-features/caching.md'
|
|
|
|
|
- Change Logging: 'additional-features/change-logging.md'
|
2020-07-30 11:36:46 -04:00
|
|
|
- Context Data: 'models/extras/configcontext.md'
|
2019-09-20 09:10:32 -04:00
|
|
|
- Custom Fields: 'additional-features/custom-fields.md'
|
2019-12-05 21:07:43 -05:00
|
|
|
- Custom Links: 'additional-features/custom-links.md'
|
2019-09-20 09:10:32 -04:00
|
|
|
- Custom Scripts: 'additional-features/custom-scripts.md'
|
2018-07-17 17:23:10 -04:00
|
|
|
- Export Templates: 'additional-features/export-templates.md'
|
|
|
|
|
- Graphs: 'additional-features/graphs.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'
|
2018-07-17 17:23:10 -04:00
|
|
|
- Reports: 'additional-features/reports.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'
|
|
|
|
|
- Developing Plugins: 'plugins/development.md'
|
2018-07-20 15:26:01 -04:00
|
|
|
- Administration:
|
2020-06-01 15:28:36 -04:00
|
|
|
- Permissions: 'administration/permissions.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'
|
2018-07-17 17:23:10 -04:00
|
|
|
- API:
|
|
|
|
|
- Overview: 'api/overview.md'
|
2020-03-05 17:23:56 -05:00
|
|
|
- Filtering: 'api/filtering.md'
|
2018-07-17 17:23:10 -04:00
|
|
|
- Authentication: 'api/authentication.md'
|
|
|
|
|
- Working with Secrets: 'api/working-with-secrets.md'
|
|
|
|
|
- Examples: 'api/examples.md'
|
|
|
|
|
- Development:
|
2018-07-27 13:42:18 -04:00
|
|
|
- Introduction: 'development/index.md'
|
2018-11-12 14:36:09 -05:00
|
|
|
- Style Guide: 'development/style-guide.md'
|
2018-07-17 17:23:10 -04:00
|
|
|
- Utility Views: 'development/utility-views.md'
|
2018-11-12 13:59:58 -05:00
|
|
|
- Extending Models: 'development/extending-models.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'
|
2018-08-02 11:53:31 -04:00
|
|
|
- Release Checklist: 'development/release-checklist.md'
|
2019-10-10 12:02:53 -04:00
|
|
|
- Release Notes:
|
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'
|
