| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145 |
- site_name: NetBox Documentation
- site_dir: netbox/project-static/docs
- site_url: https://netbox.readthedocs.io/
- repo_name: netbox-community/netbox
- repo_url: https://github.com/netbox-community/netbox
- theme:
- name: material
- icon:
- repo: fontawesome/brands/github
- palette:
- - scheme: default
- toggle:
- icon: material/lightbulb-outline
- name: Switch to Dark Mode
- - scheme: slate
- toggle:
- icon: material/lightbulb
- name: Switch to Light Mode
- plugins:
- - mkdocstrings:
- handlers:
- python:
- setup_commands:
- - import os
- - import django
- - os.environ.setdefault("DJANGO_SETTINGS_MODULE", "netbox.settings")
- - django.setup()
- rendering:
- show_root_heading: true
- show_root_full_path: false
- show_root_toc_entry: false
- extra:
- social:
- - icon: fontawesome/brands/github
- link: https://github.com/netbox-community/netbox
- - icon: fontawesome/brands/slack
- link: https://netdev.chat/
- extra_css:
- - extra.css
- markdown_extensions:
- - admonition
- - attr_list
- - markdown_include.include:
- base_path: 'docs/'
- headingOffset: 1
- - pymdownx.emoji:
- emoji_index: !!python/name:materialx.emoji.twemoji
- emoji_generator: !!python/name:materialx.emoji.to_svg
- - pymdownx.superfences
- - pymdownx.tabbed
- nav:
- - Introduction: 'index.md'
- - Installation:
- - Installing NetBox: 'installation/index.md'
- - 1. PostgreSQL: 'installation/1-postgresql.md'
- - 2. Redis: 'installation/2-redis.md'
- - 3. NetBox: 'installation/3-netbox.md'
- - 4. Gunicorn: 'installation/4-gunicorn.md'
- - 5. HTTP Server: 'installation/5-http-server.md'
- - 6. LDAP (Optional): 'installation/6-ldap.md'
- - Upgrading NetBox: 'installation/upgrading.md'
- - Migrating to systemd: 'installation/migrating-to-systemd.md'
- - Configuration:
- - Configuring NetBox: 'configuration/index.md'
- - Required Settings: 'configuration/required-settings.md'
- - Optional Settings: 'configuration/optional-settings.md'
- - Dynamic Settings: 'configuration/dynamic-settings.md'
- - Remote Authentication: 'configuration/remote-authentication.md'
- - Core Functionality:
- - IP Address Management: 'core-functionality/ipam.md'
- - VLAN Management: 'core-functionality/vlans.md'
- - Sites and Racks: 'core-functionality/sites-and-racks.md'
- - Devices and Cabling: 'core-functionality/devices.md'
- - Device Types: 'core-functionality/device-types.md'
- - Modules: 'core-functionality/modules.md'
- - Virtualization: 'core-functionality/virtualization.md'
- - Service Mapping: 'core-functionality/services.md'
- - Circuits: 'core-functionality/circuits.md'
- - Wireless: 'core-functionality/wireless.md'
- - Power Tracking: 'core-functionality/power.md'
- - Tenancy: 'core-functionality/tenancy.md'
- - Contacts: 'core-functionality/contacts.md'
- - Customization:
- - Custom Fields: 'customization/custom-fields.md'
- - Custom Validation: 'customization/custom-validation.md'
- - Custom Links: 'models/extras/customlink.md'
- - Export Templates: 'customization/export-templates.md'
- - Custom Scripts: 'customization/custom-scripts.md'
- - Reports: 'customization/reports.md'
- - Additional Features:
- - Change Logging: 'additional-features/change-logging.md'
- - Context Data: 'models/extras/configcontext.md'
- - Journaling: 'additional-features/journaling.md'
- - NAPALM: 'additional-features/napalm.md'
- - Prometheus Metrics: 'additional-features/prometheus-metrics.md'
- - Tags: 'models/extras/tag.md'
- - Webhooks: 'additional-features/webhooks.md'
- - Plugins:
- - Using Plugins: 'plugins/index.md'
- - Developing Plugins:
- - Introduction: 'plugins/development/index.md'
- - Model Features: 'plugins/development/model-features.md'
- - Developing Plugins (Old): 'plugins/development.md'
- - Administration:
- - Authentication: 'administration/authentication.md'
- - Permissions: 'administration/permissions.md'
- - Housekeeping: 'administration/housekeeping.md'
- - Replicating NetBox: 'administration/replicating-netbox.md'
- - NetBox Shell: 'administration/netbox-shell.md'
- - REST API:
- - Overview: 'rest-api/overview.md'
- - Filtering: 'rest-api/filtering.md'
- - Authentication: 'rest-api/authentication.md'
- - GraphQL API:
- - Overview: 'graphql-api/overview.md'
- - Reference:
- - Conditions: 'reference/conditions.md'
- - Development:
- - Introduction: 'development/index.md'
- - Getting Started: 'development/getting-started.md'
- - Style Guide: 'development/style-guide.md'
- - Models: 'development/models.md'
- - Adding Models: 'development/adding-models.md'
- - Extending Models: 'development/extending-models.md'
- - Signals: 'development/signals.md'
- - Application Registry: 'development/application-registry.md'
- - User Preferences: 'development/user-preferences.md'
- - Web UI: 'development/web-ui.md'
- - Release Checklist: 'development/release-checklist.md'
- - Release Notes:
- - Summary: 'release-notes/index.md'
- - Version 3.1: 'release-notes/version-3.1.md'
- - Version 3.0: 'release-notes/version-3.0.md'
- - Version 2.11: 'release-notes/version-2.11.md'
- - Version 2.10: 'release-notes/version-2.10.md'
- - Version 2.9: 'release-notes/version-2.9.md'
- - Version 2.8: 'release-notes/version-2.8.md'
- - Version 2.7: 'release-notes/version-2.7.md'
- - 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'
|
