Release v2.2-beta2

.gitattributes

@@ -1,5 +1 @@
 *.sh text eol=lf
-# Treat compiled JS/CSS files as binary, as they're not meant to be human-readable
-netbox/project-static/dist/*.css binary
-netbox/project-static/dist/*.js binary
-netbox/project-static/dist/*.js.map binary

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,41 @@
+<!--
+    Before opening a new issue, please search through the existing issues to
+    see if your topic has already been addressed. Note that you may need to
+    remove the "is:open" filter from the search bar to include closed issues.
+
+    Check the appropriate type for your issue below by placing an x between the
+    brackets. If none of the below apply, please raise your issue for
+    discussion on our mailing list:
+
+        https://groups.google.com/forum/#!forum/netbox-discuss
+
+    Please note that issues which do not fall under any of the below categories
+    will be closed.
+--->
+### Issue type
+[ ] Feature request <!-- Requesting the implementation of a new feature -->
+[ ] Bug report      <!-- Reporting unexpected or erroneous behavior -->
+[ ] Documentation   <!-- Proposing a modification to the documentation -->
+
+<!--
+    Please describe the environment in which you are running NetBox. (Be sure
+    to verify that you are running the latest stable release of NetBox before
+    submitting a bug report.)
+-->
+### Environment
+* Python version:  <!-- Example: 3.5.4 -->
+* NetBox version:  <!-- Example: 2.1.3 -->
+
+<!--
+    BUG REPORTS must include:
+        * A list of the steps needed to reproduce the bug
+        * A description of the expected behavior
+        * Any relevant error messages (screenshots may also help)
+
+    FEATURE REQUESTS must include:
+        * A detailed description of the proposed functionality
+        * A use case for the new feature
+        * A rough description of any necessary changes to the database schema
+        * Any relevant third-party libraries which would be needed
+-->
+### Description

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -1,60 +0,0 @@
----
-name: 🐛 Bug Report
-description: Report a reproducible bug in the current release of NetBox
-labels: ["type: bug"]
-body:
-  - type: markdown
-    attributes:
-      value: >
-        **NOTE:** This form is only for reporting _reproducible bugs_ in a current NetBox
-        installation. If you're having trouble with installation or just looking for
-        assistance with using NetBox, please visit our
-        [discussion forum](https://github.com/netbox-community/netbox/discussions) instead.
-  - type: input
-    attributes:
-      label: NetBox version
-      description: What version of NetBox are you currently running?
-      placeholder: v3.3.2
-    validations:
-      required: true
-  - type: dropdown
-    attributes:
-      label: Python version
-      description: What version of Python are you currently running?
-      options:
-        - "3.8"
-        - "3.9"
-        - "3.10"
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Steps to Reproduce
-      description: >
-        Describe in detail the exact steps that someone else can take to
-        reproduce this bug using the current stable release of NetBox. Begin with the
-        creation of any necessary database objects and call out every operation being
-        performed explicitly. If reporting a bug in the REST API, be sure to reconstruct
-        the raw HTTP request(s) being made: Don't rely on a client library such as
-        pynetbox. Additionally, **do not rely on the demo instance** for reproducing
-        suspected bugs, as its data is prone to modification or deletion at any time.
-      placeholder: |
-        1. Click on "create widget"
-        2. Set foo to 12 and bar to G
-        3. Click the "create" button
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Expected Behavior
-      description: What did you expect to happen?
-      placeholder: A new widget should have been created with the specified attributes
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Observed Behavior
-      description: What happened instead?
-      placeholder: A TypeError exception was raised
-    validations:
-      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -1,12 +0,0 @@
-# Reference: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
-blank_issues_enabled: false
-contact_links:
-  - name: 📖 Contributing Policy
-    url: https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md
-    about: "Please read through our contributing policy before opening an issue or pull request"
-  - name: ❓ Discussion
-    url: https://github.com/netbox-community/netbox/discussions
-    about: "If you're just looking for help, try starting a discussion instead"
-  - name: 💬 Community Slack
-    url: https://netdev.chat/
-    about: "Join #netbox on the NetDev Community Slack for assistance with installation issues and other problems"

.github/ISSUE_TEMPLATE/documentation_change.yaml

@@ -1,35 +0,0 @@
----
-name: 📖 Documentation Change
-description: Suggest an addition or modification to the NetBox documentation
-labels: ["type: documentation"]
-body:
-  - type: dropdown
-    attributes:
-      label: Change Type
-      description: What type of change are you proposing?
-      options:
-        - Addition
-        - Correction
-        - Removal
-        - Cleanup (formatting, typos, etc.)
-    validations:
-      required: true
-  - type: dropdown
-    attributes:
-      label: Area
-      description: To what section of the documentation does this change primarily pertain?
-      options:
-        - Installation instructions
-        - Configuration parameters
-        - Functionality/features
-        - REST API
-        - Administration/development
-        - Other
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Proposed Changes
-      description: Describe the proposed changes and why they are necessary.
-    validations:
-      required: true

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -1,59 +0,0 @@
----
-name: ✨ Feature Request
-description: Propose a new NetBox feature or enhancement
-labels: ["type: feature"]
-body:
-  - type: markdown
-    attributes:
-      value: >
-        **NOTE:** This form is only for submitting well-formed proposals to extend or modify
-        NetBox in some way. If you're trying to solve a problem but can't figure out how, or if
-        you still need time to work on the details of a proposed new feature, please start a
-        [discussion](https://github.com/netbox-community/netbox/discussions) instead.
-  - type: input
-    attributes:
-      label: NetBox version
-      description: What version of NetBox are you currently running?
-      placeholder: v3.3.2
-    validations:
-      required: true
-  - type: dropdown
-    attributes:
-      label: Feature type
-      options:
-        - Data model extension
-        - New functionality
-        - Change to existing functionality
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Proposed functionality
-      description: >
-        Describe in detail the new feature or behavior you are proposing. Include any specific changes
-        to work flows, data models, and/or the user interface. The more detail you provide here, the
-        greater chance your proposal has of being discussed. Feature requests which don't include an
-        actionable implementation plan will be rejected.
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Use case
-      description: >
-        Explain how adding this functionality would benefit NetBox users. What need does it address?
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Database changes
-      description: >
-        Note any changes to the database schema necessary to support the new feature. For example,
-        does the proposal require adding a new model or field? (Not all new features require database
-        changes.)
-  - type: textarea
-    attributes:
-      label: External dependencies
-      description: >
-        List any new dependencies on external libraries or services that this new feature would
-        introduce. For example, does the proposal require the installation of a new Python package?
-        (Not all new features introduce new dependencies.)

.github/ISSUE_TEMPLATE/housekeeping.yaml

@@ -1,24 +0,0 @@
----
-name: 🏡 Housekeeping
-description: A change pertaining to the codebase itself (developers only)
-labels: ["type: housekeeping"]
-body:
-  - type: markdown
-    attributes:
-      value: >
-        **NOTE:** This template is for use by maintainers only. Please do not submit
-        an issue using this template unless you have been specifically asked to do so.
-  - type: textarea
-    attributes:
-      label: Proposed Changes
-      description: >
-        Describe in detail the new feature or behavior you'd like to propose.
-        Include any specific changes to work flows, data models, or the user interface.
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Justification
-      description: Please provide justification for the proposed change(s).
-    validations:
-      required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,15 +1,13 @@
 <!--
-    Thank you for your interest in contributing to NetBox! Please note that
-    our contribution policy requires that a feature request or bug report be
-    approved and assigned prior to filing a pull request. This helps avoid
-    wasting time and effort on something that we might not be able to accept.
+    Thank you for your interest in contributing to NetBox! Please note
+    that our contribution policy requires that a feature request or bug
+    report be opened for approval prior to filing a pull request. This
+    helps avoid wasting time and effort on something that we might not
+    be able to accept.
 
-    IF YOUR PULL REQUEST DOES NOT REFERENCE AN ISSUE WHICH HAS BEEN ASSIGNED
-    TO YOU, IT WE BE CLOSED AUTOMATICALLY.
-
-    Specify your assigned issue number on the line below.
+    Please indicate the relevant feature request or bug report below.
 -->
-### Fixes: #1234
+### Fixes:
 
 <!--
     Please include a summary of the proposed changes below.

.github/workflows/ci.yml

@@ -1,82 +0,0 @@
-name: CI
-on: [push, pull_request]
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    env:
-      NETBOX_CONFIGURATION: netbox.configuration_testing
-    strategy:
-      matrix:
-        python-version: ['3.8', '3.9', '3.10']
-        node-version: ['14.x']
-    services:
-      redis:
-        image: redis
-        ports:
-          - 6379:6379
-      postgres:
-        image: postgres
-        env:
-          POSTGRES_USER: netbox
-          POSTGRES_PASSWORD: netbox
-        options: >-
-          --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-        ports:
-          - 5432:5432
-
-    steps:
-    - name: Check out repo
-      uses: actions/checkout@v2
-
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
-      with:
-        node-version: ${{ matrix.node-version }}
-    
-    - name: Install Yarn Package Manager
-      run: npm install -g yarn
-    
-    - name: Setup Node.js with Yarn Caching
-      uses: actions/setup-node@v2
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: yarn
-        cache-dependency-path: netbox/project-static/yarn.lock
-    
-    - name: Install Frontend Dependencies
-      run: yarn --cwd netbox/project-static
-
-    - name: Install dependencies & set up configuration
-      run: |
-        python -m pip install --upgrade pip
-        pip install -r requirements.txt
-        pip install pycodestyle coverage tblib
-
-    - name: Build documentation
-      run: mkdocs build
-
-    - name: Collect static files
-      run: python netbox/manage.py collectstatic --no-input
-
-    - name: Check PEP8 compliance
-      run: pycodestyle --ignore=W504,E501 --exclude=node_modules netbox/
-
-    - name: Check UI ESLint, TypeScript, and Prettier Compliance
-      run: yarn --cwd netbox/project-static validate
-    
-    - name: Validate Static Asset Integrity
-      run: scripts/verify-bundles.sh
-
-    - name: Run tests
-      run: coverage run --source="netbox/" netbox/manage.py test netbox/ --parallel
-
-    - name: Show coverage report
-      run: coverage report --skip-covered --omit *migrations*

.github/workflows/lock.yml

@@ -1,21 +0,0 @@
-# lock-threads (https://github.com/marketplace/actions/lock-threads)
-name: 'Lock threads'
-
-on:
-  schedule:
-    - cron: '0 3 * * *'
-
-jobs:
-  lock:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: dessant/lock-threads@v2
-        with:
-          github-token: ${{ github.token }}
-          issue-lock-inactive-days: '90'
-          issue-exclude-created-before: ''
-          issue-exclude-labels: ''
-          issue-lock-labels: ''
-          issue-lock-comment: ''
-          issue-lock-reason: 'resolved'
-          process-only: 'issues'

.github/workflows/stale.yml

@@ -1,38 +0,0 @@
-# close-stale-issues (https://github.com/marketplace/actions/close-stale-issues)
-name: 'Close stale issues/PRs'
-on:
-  schedule:
-    - cron: '0 4 * * *'
-
-jobs:
-  stale:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/stale@v5
-        with:
-          close-issue-message: >
-            This issue has been automatically closed due to lack of activity. In an
-            effort to reduce noise, please do not comment any further. Note that the
-            core maintainers may elect to reopen this issue at a later date if deemed
-            necessary.
-          close-pr-message: >
-            This PR has been automatically closed due to lack of activity.
-          days-before-stale: 60
-          days-before-close: 30
-          exempt-issue-labels: 'status: accepted,status: blocked,status: needs milestone'
-          operations-per-run: 100
-          remove-stale-when-updated: false
-          stale-issue-label: 'pending closure'
-          stale-issue-message: >
-            This issue has been automatically marked as stale because it has not had
-            recent activity. It will be closed if no further activity occurs. NetBox
-            is governed by a small group of core maintainers which means not all opened
-            issues may receive direct feedback. **Do not** attempt to circumvent this
-            process by "bumping" the issue; doing so will result in its immediate closure
-            and you may be barred from participating in any future discussions. Please see
-            our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
-          stale-pr-label: 'pending closure'
-          stale-pr-message: >
-            This PR has been automatically marked as stale because it has not had
-            recent activity. It will be closed automatically if no further action is
-            taken.

.gitignore

@@ -1,28 +1,12 @@
 *.pyc
-*.swp
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-/netbox/project-static/node_modules
-/netbox/project-static/docs/*
-!/netbox/project-static/docs/.info
 /netbox/netbox/configuration.py
 /netbox/netbox/ldap_config.py
-/netbox/local/*
 /netbox/reports/*
 !/netbox/reports/__init__.py
-/netbox/scripts/*
-!/netbox/scripts/__init__.py
 /netbox/static
-/venv/
+.idea
 /*.sh
-local_requirements.txt
 !upgrade.sh
 fabfile.py
-gunicorn.py
-netbox.log
-netbox.pid
-.DS_Store
-.idea
-.coverage
-.vscode
+*.swp
+gunicorn_config.py

.readthedocs.yaml

@@ -1,10 +0,0 @@
-version: 2
-build:
-  os: ubuntu-20.04
-  tools:
-    python: "3.9"
-mkdocs:
-  configuration: mkdocs.yml
-python:
-   install:
-   - requirements: requirements.txt

.travis.yml

@@ -0,0 +1,17 @@
+sudo: required
+services:
+  - postgresql
+addons:
+  postgresql: "9.4"
+language: python
+python:
+  - "2.7"
+  - "3.5"
+install:
+  - pip install -r requirements.txt
+  - pip install pep8
+before_script:
+  - psql --version
+  - psql -U postgres -c 'SELECT version();'
+script:
+  - ./scripts/cibuild.sh

CHANGELOG.md

@@ -1 +0,0 @@
-The changelog has been moved to the [project release notes](https://docs.netbox.dev/en/stable/release-notes/).

CONTRIBUTING.md

@@ -1,188 +1,121 @@
 ## Getting Help
 
 If you encounter any issues installing or using NetBox, try one of the
-following resources to get assistance. Please **do not** open a GitHub issue
-except to report bugs or request features.
+following resources to get assistance. Please **do not** open a GitHub
+issue except to report bugs or request features.
 
-### GitHub Discussions
+### Mailing List
 
-GitHub's discussions are the best place to get help or propose rough ideas for
-new functionality. Their integration with GitHub allows for easily cross-
-referencing and converting posts to issues as needed. There are several
-categories for discussions:
+We have established a Google Groups Mailing List for issues and general
+discussion. This is the best forum for obtaining assistance with NetBox
+installation. You can find us [here](https://groups.google.com/forum/#!forum/netbox-discuss).
 
-* **General** - General community discussion
-* **Ideas** - Ideas for new functionality that isn't yet ready for a formal
-  feature request
-* **Q&A** - Request help with installing or using NetBox
+### Freenode IRC
 
-### Slack
-
-For real-time chat, you can join the **#netbox** Slack channel on [NetDev Community](https://netdev.chat/).
-Unfortunately, the Slack channel does not provide long-term retention of chat
-history, so try to avoid it for any discussions would benefit from being
-preserved for future reference.
+For real-time discussion, you can join the #netbox channel on [Freenode](https://freenode.net/).
+You can connect to Freenode at irc.freenode.net using an IRC client, or
+you can use their [webchat client](https://webchat.freenode.net/).
 
 ## Reporting Bugs
 
-* First, ensure that you're running the [latest stable version](https://github.com/netbox-community/netbox/releases)
-of NetBox. If you're running an older version, it's possible that the bug has
-already been fixed.
+* First, ensure that you've installed the [latest stable version](https://github.com/digitalocean/netbox/releases) of
+NetBox. If you're running an older version, it's possible that the bug
+has already been fixed.
 
-* Next, check the GitHub [issues list](https://github.com/netbox-community/netbox/issues)
-to see if the bug you've found has already been reported. If you think you may
-be experiencing a reported issue that hasn't already been resolved, please
-click "add a reaction" in the top right corner of the issue and add a thumbs
-up (+1). You might also want to add a comment describing how it's affecting your
-installation. This will allow us to prioritize bugs based on how many users are
-affected.
+* Next, check the GitHub [issues list](https://github.com/digitalocean/netbox/issues) to see if the bug you've found has
+already been reported. If you think you may be experiencing a reported
+issue that hasn't already been resolved, please click "add a reaction"
+in the top right corner of the issue and add a thumbs up (+1). You might
+also want to add a comment describing how it's affecting your
+installation. This will allow us to prioritize bugs based on how many
+users are affected.
 
-* When submitting an issue, please be as descriptive as possible. Be sure to
-provide all information request in the issue template, including:
+* If you haven't found an existing issue that describes your suspected
+bug, please inquire about it on the mailing list. **Do not** file an
+issue until you have received confirmation that it is in fact a bug.
+Invalid issues are very distracting and slow the pace at which NetBox is
+developed.
+
+* When submitting an issue, please be as descriptive as possible. Be
+sure to include:
 
     * The environment in which NetBox is running
-    * The exact steps that can be taken to reproduce the issue
-    * Expected and observed behavior
+    * The exact steps that can be taken to reproduce the issue (if
+      applicable)
     * Any error messages generated
     * Screenshots (if applicable)
 
 * Please avoid prepending any sort of tag (e.g. "[Bug]") to the issue title.
-The issue will be reviewed by a maintainer after submission and the appropriate
-labels will be applied for categorization.
+The issue will be reviewed by a moderator after submission and the appropriate
+labels will be applied.
 
-* Keep in mind that we prioritize bugs based on their severity and how much
-work is required to resolve them. It may take some time for someone to address
-your issue.
-
-* For more information on how bug reports are handled, please see our [issue
-intake policy](https://github.com/netbox-community/netbox/wiki/Issue-Intake-Policy).
+* Keep in mind that we prioritize bugs based on their severity and how
+much work is required to resolve them. It may take some time for someone
+to address your issue.
 
 ## Feature Requests
 
-* First, check the GitHub [issues list](https://github.com/netbox-community/netbox/issues)
-to see if the feature you're requesting is already listed. (Be sure to search
-closed issues as well, since some feature requests have been rejected.) If the
-feature you'd like to see has already been requested and is open, click "add a
-reaction" in the top right corner of the issue and add a thumbs up (+1). This
-ensures that the issue has a better chance of receiving attention. Also feel
-free to add a comment with any additional justification for the feature.
+* First, check the GitHub [issues list](https://github.com/digitalocean/netbox/issues) to see if the feature you're
+requesting is already listed. (Be sure to search closed issues as well,
+since some feature requests are rejected.) If the feature you'd like to
+see has already been requested, click "add a reaction" in the top right
+corner of the issue and add a thumbs up (+1). This ensures that the
+issue has a better chance of making it onto the roadmap. Also feel free
+to add a comment with any additional justification for the feature.
 (However, note that comments with no substance other than a "+1" will be
-deleted. Please use GitHub's reactions feature to indicate your support.)
+deleted. Please use GitHub's reactions feature to indicate your
+support.)
 
-* Before filing a new feature request, consider raising your idea in a
-[GitHub discussion](https://github.com/netbox-community/netbox/discussions)
-first. Feedback you receive there will help validate and shape the proposed
-feature before filing a formal issue.
+* While suggestions for new features are welcome, it's important to
+limit the scope of NetBox's feature set to avoid feature creep. For
+example, the following features would be firmly out of scope for NetBox:
 
-* Good feature requests are very narrowly defined. Be sure to thoroughly
-describe the functionality and data model(s) being proposed. The more effort
-you put into writing a feature request, the better its chance is of being
+    * Ticket management
+    * Network state monitoring
+    * Acting as a DNS server
+    * Acting as an authentication server
+
+* Before filing a new feature request, consider raising your idea on the
+mailing list first. Feedback you receive there will help validate and
+shape the proposed feature before filing a formal issue.
+
+* Good feature requests are very narrowly defined. Be sure to enumerate
+specific functionality and data schema. The more effort you put into
+writing a feature request, the better its chance is of being
 implemented. Overly broad feature requests will be closed.
 
-* When submitting a feature request on GitHub, be sure to include all
-information requested by the issue template, including:
+* When submitting a feature request on GitHub, be sure to include the
+following:
 
     * A detailed description of the proposed functionality
-    * A use case for the feature; who would use it and what value it would add
-      to NetBox
-    * A rough description of changes necessary to the database schema (if
-      applicable)
-    * Any third-party libraries or other resources which would be involved
+    * A use case for the feature; who would use it and what value it
+      would add to NetBox
+    * A rough description of changes necessary to the database schema
+      (if applicable)
+    * Any third-party libraries or other resources which would be
+      involved
 
-* Please avoid prepending any sort of tag (e.g. "[Feature]") to the issue
-title. The issue will be reviewed by a moderator after submission and the
-appropriate labels will be applied for categorization.
-
-* For more information on how feature requests are handled, please see our
-[issue intake policy](https://github.com/netbox-community/netbox/wiki/Issue-Intake-Policy).
+* Please avoid prepending any sort of tag (e.g. "[Feature]") to the issue title.
+The issue will be reviewed by a moderator after submission and the appropriate
+labels will be applied.
 
 ## Submitting Pull Requests
 
-* If you're interested in contributing to NetBox, be sure to check out our
-[getting started](https://docs.netbox.dev/en/stable/development/getting-started/)
-documentation for tips on setting up your development environment.
+* Be sure to open an issue before starting work on a pull request, and
+discuss your idea with the NetBox maintainers before beginning work​.
+This will help prevent wasting time on something that might we might not
+be able to implement. When suggesting a new feature, also make sure it
+won't conflict with any work that's already in progress.
 
-* Be sure to open an issue and wait for it to be assigned to you **before**
-starting work on a pull request, and discuss your idea with the NetBox
-maintainers before beginning work. This will help prevent wasting time on
-proposed changes that we might not be able to accept. When suggesting a new
-feature, also make sure it won't conflict with any work that's already in
-progress.
+* When submitting a pull request, please be sure to work off of the
+`develop` branch, rather than `master`. In NetBox, the `develop` branch
+is used for ongoing development, while `master` is used for tagging new
+stable releases.
 
-* Once you've opened or identified an issue you'd like to work on, ask that it
-be assigned to you so that others are aware it's being worked on. If it meets
-the acceptance criteria, a maintainer will then mark the issue as "accepted"
-and assign it to you. (Note that GitHub requires that a user first comment on
-an issue before it can be assigned to that user.)
-
-* Any pull request which does not relate to an **assigned** issue will be
-closed.
-
-* All new functionality must include relevant tests where applicable.
-
-* When submitting a pull request, please be sure to work off of the `develop`
-branch, rather than `master`. The `develop` branch is used for ongoing
-development, while `master` is used for tagging stable releases. (If you're
-developing for the next minor release, use `feature` instead.)
-
-* In most cases, it is not necessary to add a changelog entry: A maintainer will
-take care of this when the PR is merged. (This helps avoid merge conflicts
-resulting from multiple PRs being submitted simultaneously.)
-
-* All code submissions should meet the following criteria (CI will enforce
-these checks):
+* All code submissions should meet the following criteria (CI will
+enforce these checks):
 
     * Python syntax is valid
     * All tests pass when run with `./manage.py test`
     * PEP 8 compliance is enforced, with the exception that lines may be
       greater than 80 characters in length
-
-## Commenting
-
-Only comment on an issue if you are sharing a relevant idea or constructive
-feedback. **Do not** comment on an issue just to show your support (give the
-top post a :+1: instead) or to ask for an update. Doing so generates
-unnecessary noise in the discussion, and is especially annoying for people who
-have subscribed to updates for the issue. Any comments without substance
-relevant to the discussion will be deleted.
-
-## Issue Lifecycle
-
-New issues are handled according to our [issue intake policy](https://github.com/netbox-community/netbox/wiki/Issue-Intake-Policy).
-Maintainers will assign label(s) and/or close new issues as the policy
-dictates. This helps ensure a productive development environment and avoid
-accumulating a large backlog of work.
-
-The core maintainers group has chosen to make use of GitHub's [Stale bot](https://github.com/apps/stale)
-to aid in issue management.
-
-* Issues will be marked as stale after 60 days of no activity.
-* If the stable label is not removed in the following 30 days, the issue will
-  be closed automatically.
-* Any issue bearing one of the following labels will be exempt from all Stale
-  bot actions:
-  * `status: accepted`
-  * `status: blocked`
-  * `status: needs milestone`
-
-It is natural that some new issues get more attention than others. The stale
-bot helps bring renewed attention to potentially valuable issues that may have
-been overlooked. **Do not** comment on a stale issue merely to "bump" it in an
-effort to circumvent the bot: This will result in the immediate closure of the
-issue, and you may be barred from participating in future discussions.
-
-## Maintainer Guidance
-
-* Maintainers are expected to contribute at least four hours per week to the
-  project on average. This can be employer-sponsored or individual time, with
-  the understanding that all contributions are submitted under the Apache 2.0
-  license and that your employer may not make claim to any contributions.
-  Contributions include code work, issue management, and community support. All
-  development must be in accordance with our [development guidance](https://docs.netbox.dev/en/stable/development/).
-
-* Maintainers are expected to attend (where feasible) our biweekly ~30-minute
-  sync to review agenda items. This meeting provides opportunity to present and
-  discuss pressing topics. Meetings are held as virtual audio/video conferences.
-
-* Maintainers with no substantial recorded activity in a 60-day period will be
-  removed from the project.

NOTICE

@@ -1,7 +0,0 @@
-Copyrighted and licensed under Apache License 2.0 by DigitalOcean, LLC.
-
-This project contains code developed expressly for NetBox, and its reuse in
-other projects may introduce issues affecting performance, data integrity,
-and security.
-
-For more information, please see https://github.com/netbox-community/netbox.

README.md

@@ -1,109 +1,36 @@
-<div align="center">
-  <img src="https://raw.githubusercontent.com/netbox-community/netbox/develop/docs/netbox_logo.svg" width="400" alt="NetBox logo" />
-</div>
+![NetBox](docs/netbox_logo.png "NetBox logo")
 
-![Master branch build status](https://github.com/netbox-community/netbox/workflows/CI/badge.svg?branch=master)
+NetBox is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at [DigitalOcean](https://www.digitalocean.com/), NetBox was developed specifically to address the needs of network and infrastructure engineers.
 
-NetBox is the leading solution for modeling and documenting modern networks. By
-combining the traditional disciplines of IP address management (IPAM) and
-datacenter infrastructure management (DCIM) with powerful APIs and extensions,
-NetBox provides the ideal "source of truth" to power network automation.
-Available as open source software under the Apache 2.0 license, NetBox is
-employed by thousands of organizations around the world.
+NetBox runs as a web application atop the [Django](https://www.djangoproject.com/) Python framework with a [PostgreSQL](http://www.postgresql.org/) database. For a complete list of requirements, see `requirements.txt`. The code is available [on GitHub](https://github.com/digitalocean/netbox).
 
-![Screenshot of Netbox UI](docs/media/screenshots/netbox-ui.png "NetBox UI")
+The complete documentation for NetBox can be found at [Read the Docs](http://netbox.readthedocs.io/en/stable/).
 
-Myriad infrastructure components can be modeled in NetBox, including:
+Questions? Comments? Please subscribe to [the netbox-discuss mailing list](https://groups.google.com/forum/#!forum/netbox-discuss), or join us on IRC in **#netbox** on **irc.freenode.net**!
 
-* Hierarchical regions, site groups, sites, and locations
-* Racks, devices, and device components
-* Cables and wireless connections
-* Power distribution
-* Data circuits and providers
-* Virtual machines and clusters
-* IP prefixes, ranges, and addresses
-* VRFs and route targets
-* L2VPN and overlays
-* FHRP groups (VRRP, HSRP, etc.)
-* AS numbers
-* VLANs and scoped VLAN groups
-* Organizational tenants and contacts
+### Build Status
 
-In addition to its extensive built-in models and functionality, NetBox can be
-customized and extended through the use of:
+NetBox is built against both Python 2.7 and 3.5.  Python 3.5 is recommended.
 
-* Custom fields
-* Custom links
-* Configuration contexts
-* Custom model validation rules
-* Reports
-* Custom scripts
-* Export templates
-* Conditional webhooks
-* Plugins
-* Single sign-on (SSO) authentication
-* NAPALM integration
-* Detailed change logging
+|             | status |
+|-------------|------------|
+| **master** | [![Build Status](https://travis-ci.org/digitalocean/netbox.svg?branch=master)](https://travis-ci.org/digitalocean/netbox) |
+| **develop** | [![Build Status](https://travis-ci.org/digitalocean/netbox.svg?branch=develop)](https://travis-ci.org/digitalocean/netbox) |
 
-NetBox also features a complete REST API as well as a GraphQL API for easily
-integrating with other tools and systems.
+## Screenshots
 
-The complete documentation for NetBox can be found at [docs.netbox.dev](https://docs.netbox.dev/).
-A public demo instance is available at [demo.netbox.dev](https://demo.netbox.dev).
+![Screenshot of main page](docs/media/screenshot1.png "Main page")
 
-NetBox runs as a web application atop the [Django](https://www.djangoproject.com/)
-Python framework with a [PostgreSQL](https://www.postgresql.org/) database. For a
-complete list of requirements, see `requirements.txt`. The code is available
-[on GitHub](https://github.com/netbox-community/netbox).
+![Screenshot of rack elevation](docs/media/screenshot2.png "Rack elevation")
 
-<div align="center">
-  <h4>Thank you to our sponsors!</h4>
+![Screenshot of prefix hierarchy](docs/media/screenshot3.png "Prefix hierarchy")
 
-  [![DigitalOcean](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/digitalocean.png)](https://try.digitalocean.com/developer-cloud)
-  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-  [![Equinix Metal](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/equinix.png)](https://metal.equinix.com/)
-  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-  [![NS1](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/ns1.png)](https://ns1.com/)
-  <br />
-  [![Sentry](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/sentry.png)](https://sentry.io/)
-  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-  [![Stellar Technologies](https://raw.githubusercontent.com/wiki/netbox-community/netbox/images/sponsors/stellar.png)](https://stellar.tech/)
+# Installation
 
-</div>
+Please see [the documentation](http://netbox.readthedocs.io/en/stable/) for instructions on installing NetBox. To upgrade NetBox, please download the [latest release](https://github.com/digitalocean/netbox/releases) and run `upgrade.sh`.
 
-### Discussion
+## Alternative Installations
 
-* [GitHub Discussions](https://github.com/netbox-community/netbox/discussions) - Discussion forum hosted by GitHub; ideal for Q&A and other structured discussions
-* [Slack](https://netdev.chat/) - Real-time chat hosted by the NetDev Community; best for unstructured discussion or just hanging out
-
-### Installation
-
-Please see [the documentation](https://docs.netbox.dev/) for
-instructions on installing NetBox. To upgrade NetBox, please download the
-[latest release](https://github.com/netbox-community/netbox/releases) and
-run `upgrade.sh`.
-
-### Providing Feedback
-
-The best platform for general feedback, assistance, and other discussion is our
-[GitHub discussions](https://github.com/netbox-community/netbox/discussions).
-To report a bug or request a specific feature, please open a GitHub issue using
-the [appropriate template](https://github.com/netbox-community/netbox/issues/new/choose).
-
-If you are interested in contributing to the development of NetBox, please read
-our [contributing guide](CONTRIBUTING.md) prior to beginning any work.
-
-### Screenshots
-
-![Screenshot of main page (dark mode)](docs/media/screenshots/home-dark.png "Main page (dark mode)")
-
-![Screenshot of rack elevation](docs/media/screenshots/rack.png "Rack elevation")
-
-![Screenshot of prefixes hierarchy](docs/media/screenshots/prefixes-list.png "Prefixes hierarchy")
-
-![Screenshot of cable trace](docs/media/screenshots/cable-trace.png "Cable tracing")
-
-### Related projects
-
-Please see [our wiki](https://github.com/netbox-community/netbox/wiki/Community-Contributions)
-for a list of relevant community projects.
+* [Docker container](https://github.com/digitalocean/netbox-docker)
+* [Heroku deployment](https://heroku.com/deploy?template=https://github.com/BILDQUADRAT/netbox/tree/heroku) (via [@mraerino](https://github.com/BILDQUADRAT/netbox/tree/heroku))
+* [Vagrant deployment](https://github.com/ryanmerolle/netbox-vagrant)

SECURITY.md

@@ -1,31 +0,0 @@
-# Security Policy
-
-## No Warranty
-
-Per the terms of the Apache 2 license, NetBox is offered "as is" and without any guarantee or warranty pertaining to its operation. While every reasonable effort is made by its maintainers to ensure the product remains free of security vulnerabilities, users are ultimately responsible for conducting their own evaluations of each software release.
-
-## Recommendations
-
-Administrators are encouraged to adhere to industry best practices concerning the secure operation of software, such as:
-
-* Do not expose your NetBox installation to the public Internet
-* Do not permit multiple users to share an account
-* Enforce minimum password complexity requirements for local accounts
-* Prohibit access to your database from clients other than the NetBox application
-* Keep your deployment updated to the most recent stable release
-
-## Reporting a Suspected Vulnerability
-
-If you believe you've uncovered a security vulnerability and wish to report it confidentially, you may do so via email. Please note that any reported vulnerabilities **MUST** meet all the following conditions:
-
-* Affects the most recent stable release of NetBox, or a current beta release
-* Affects a NetBox instance installed and configured per the official documentation
-* Is reproducible following a prescribed set of instructions
-
-Please note that we **DO NOT** accept reports generated by automated tooling which merely suggest that a file or file(s) _may_ be vulnerable under certain conditions, as these are most often innocuous.
-
-If you believe that you've found a vulnerability which meets all of these conditions, please email a brief description of the suspected bug and instructions for reproduction to **security@netbox.dev**. For any security concerns regarding NetBox deployed via Docker, please see the [netbox-docker](https://github.com/netbox-community/netbox-docker) project.
-
-### Bug Bounties
-
-As NetBox is provided as free open source software, we do not offer any monetary compensation for vulnerability or bug reports, however your contributions are greatly appreciated.

base_requirements.txt

@@ -1,135 +0,0 @@
-# HTML sanitizer
-# https://github.com/mozilla/bleach
-bleach
-
-# The Python web framework on which NetBox is built
-# https://github.com/django/django
-Django<4.1
-
-# Django middleware which permits cross-domain API requests
-# https://github.com/OttoYiu/django-cors-headers
-django-cors-headers
-
-# Runtime UI tool for debugging Django
-# https://github.com/jazzband/django-debug-toolbar
-django-debug-toolbar
-
-# Library for writing reusable URL query filters
-# https://github.com/carltongibson/django-filter
-django-filter
-
-# Django debug toolbar extension with support for GraphiQL
-# https://github.com/flavors/django-graphiql-debug-toolbar/
-django-graphiql-debug-toolbar
-
-# Modified Preorder Tree Traversal (recursive nesting of objects)
-# https://github.com/django-mptt/django-mptt
-django-mptt
-
-# Context managers for PostgreSQL advisory locks
-# https://github.com/Xof/django-pglocks
-django-pglocks
-
-# Prometheus metrics library for Django
-# https://github.com/korfuri/django-prometheus
-django-prometheus
-
-# Django caching backend using Redis
-# https://github.com/jazzband/django-redis
-django-redis
-
-# Django extensions for Rich (terminal text rendering)
-# https://github.com/adamchainz/django-rich
-django-rich
-
-# Django integration for RQ (Reqis queuing)
-# https://github.com/rq/django-rq
-django-rq
-
-# Abstraction models for rendering and paginating HTML tables
-# https://github.com/jieter/django-tables2
-django-tables2
-
-# User-defined tags for objects
-# https://github.com/alex/django-taggit
-django-taggit
-
-# A Django field for representing time zones
-# https://github.com/mfogel/django-timezone-field/
-django-timezone-field
-
-# A REST API framework for Django projects
-# https://github.com/encode/django-rest-framework
-djangorestframework
-
-# Swagger/OpenAPI schema generation for REST APIs
-# https://github.com/axnsan12/drf-yasg
-drf-yasg[validation]
-
-# Django wrapper for Graphene (GraphQL support)
-# https://github.com/graphql-python/graphene-django
-graphene_django
-
-# WSGI HTTP server
-# https://gunicorn.org/
-gunicorn
-
-# Platform-agnostic template rendering engine
-# https://github.com/pallets/jinja
-Jinja2
-
-# Simple markup language for rendering HTML
-# https://github.com/Python-Markdown/markdown
-Markdown
-
-# File inclusion plugin for Python-Markdown
-# https://github.com/cmacmackin/markdown-include
-markdown-include
-
-# MkDocs Material theme (for documentation build)
-# https://github.com/squidfunk/mkdocs-material
-mkdocs-material
-
-# Introspection for embedded code
-# https://github.com/mkdocstrings/mkdocstrings
-mkdocstrings[python-legacy]
-
-# Library for manipulating IP prefixes and addresses
-# https://github.com/netaddr/netaddr
-netaddr
-
-# Fork of PIL (Python Imaging Library) for image processing
-# https://github.com/python-pillow/Pillow
-Pillow
-
-# PostgreSQL database adapter for Python
-# https://github.com/psycopg/psycopg2
-psycopg2-binary
-
-# YAML rendering library
-# https://github.com/yaml/pyyaml
-PyYAML
-
-# Sentry SDK
-# https://github.com/getsentry/sentry-python
-sentry-sdk
-
-# Social authentication framework
-# https://github.com/python-social-auth/social-core
-social-auth-core
-
-# Django app for social-auth-core
-# https://github.com/python-social-auth/social-app-django
-social-auth-app-django
-
-# SVG image rendering (used for rack elevations)
-# https://github.com/mozman/svgwrite
-svgwrite
-
-# Tabular dataset library (for table-based exports)
-# https://github.com/jazzband/tablib
-tablib
-
-# Timezone data (required by django-timezone-field on Python 3.9+)
-# https://github.com/python/tzdata
-tzdata

contrib/apache.conf

@@ -1,26 +0,0 @@
-<VirtualHost *:443>
-    ProxyPreserveHost On
-
-    # CHANGE THIS TO YOUR SERVER'S NAME
-    ServerName netbox.example.com
-
-    SSLEngine on
-    SSLCertificateFile /etc/ssl/certs/netbox.crt
-    SSLCertificateKeyFile /etc/ssl/private/netbox.key
-
-    Alias /static /opt/netbox/netbox/static
-
-    <Directory /opt/netbox/netbox/static>
-        Options Indexes FollowSymLinks MultiViews
-        AllowOverride None
-        Require all granted
-    </Directory>
-
-    <Location /static>
-        ProxyPass !
-    </Location>
-
-    RequestHeader set "X-Forwarded-Proto" expr=%{REQUEST_SCHEME}
-    ProxyPass / http://127.0.0.1:8001/
-    ProxyPassReverse / http://127.0.0.1:8001/
-</VirtualHost>

contrib/gunicorn.py

@@ -1,16 +0,0 @@
-# The IP address (typically localhost) and port that the Netbox WSGI process should listen on
-bind = '127.0.0.1:8001'
-
-# Number of gunicorn workers to spawn. This should typically be 2n+1, where
-# n is the number of CPU cores present.
-workers = 5
-
-# Number of threads per worker process
-threads = 3
-
-# Timeout (in seconds) for a request to complete
-timeout = 120
-
-# The maximum number of requests a worker can handle before being respawned
-max_requests = 5000
-max_requests_jitter = 500

contrib/netbox-housekeeping.sh

@@ -1,9 +0,0 @@
-#!/bin/sh
-# This shell script invokes NetBox's housekeeping management command, which
-# intended to be run nightly. This script can be copied into your system's
-# daily cron directory (e.g. /etc/cron.daily), or referenced directly from
-# within the cron configuration file.
-#
-# If NetBox has been installed into a nonstandard location, update the paths
-# below.
-/opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py housekeeping

contrib/netbox-rq.service

@@ -1,21 +0,0 @@
-[Unit]
-Description=NetBox Request Queue Worker
-Documentation=https://docs.netbox.dev/
-After=network-online.target
-Wants=network-online.target
-
-[Service]
-Type=simple
-
-User=netbox
-Group=netbox
-WorkingDirectory=/opt/netbox
-
-ExecStart=/opt/netbox/venv/bin/python3 /opt/netbox/netbox/manage.py rqworker high default low
-
-Restart=on-failure
-RestartSec=30
-PrivateTmp=true
-
-[Install]
-WantedBy=multi-user.target

contrib/netbox.service

@@ -1,22 +0,0 @@
-[Unit]
-Description=NetBox WSGI Service
-Documentation=https://docs.netbox.dev/
-After=network-online.target
-Wants=network-online.target
-
-[Service]
-Type=simple
-
-User=netbox
-Group=netbox
-PIDFile=/var/tmp/netbox.pid
-WorkingDirectory=/opt/netbox
-
-ExecStart=/opt/netbox/venv/bin/gunicorn --pid /var/tmp/netbox.pid --pythonpath /opt/netbox/netbox --config /opt/netbox/gunicorn.py netbox.wsgi
-
-Restart=on-failure
-RestartSec=30
-PrivateTmp=true
-
-[Install]
-WantedBy=multi-user.target

contrib/nginx.conf

@@ -1,29 +0,0 @@
-server {
-    listen [::]:443 ssl ipv6only=off;
-
-    # CHANGE THIS TO YOUR SERVER'S NAME
-    server_name netbox.example.com;
-
-    ssl_certificate /etc/ssl/certs/netbox.crt;
-    ssl_certificate_key /etc/ssl/private/netbox.key;
-
-    client_max_body_size 25m;
-
-    location /static/ {
-        alias /opt/netbox/netbox/static/;
-    }
-
-    location / {
-        proxy_pass http://127.0.0.1:8001;
-        proxy_set_header X-Forwarded-Host $http_host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-Proto $scheme;
-    }
-}
-
-server {
-    # Redirect HTTP traffic to HTTPS
-    listen [::]:80 ipv6only=off;
-    server_name _;
-    return 301 https://$host$request_uri;
-}

docs/_theme/main.html

@@ -1,9 +0,0 @@
-{% extends "base.html" %}
-
-{% block site_meta %}
-  {{ super() }}
-  {# Disable search indexing unless we're building for ReadTheDocs #}
-  {% if not config.extra.readthedocs %}
-    <meta name="robots" content="noindex">
-  {% endif %}
-{% endblock %}

docs/administration/authentication/microsoft-azure-ad.md

@@ -1,88 +0,0 @@
-# Microsoft Azure AD
-
-This guide explains how to configure single sign-on (SSO) support for NetBox using [Microsoft Azure Active Directory (AD)](https://azure.microsoft.com/en-us/services/active-directory/) as an authentication backend.
-
-## Azure AD Configuration
-
-### 1. Create a test user (optional)
-
-Create a new user in AD to be used for testing. You can skip this step if you already have a suitable account created.
-
-### 2. Create an app registration
-
-Under the Azure Active Directory dashboard, navigate to **Add > App registration**.
-
-![Add an app registration](../../media/authentication/azure_ad_add_app_registration.png)
-
-Enter a name for the registration (e.g. "NetBox") and ensure that the "single tenant" option is selected.
-
-Under "Redirect URI", select "Web" for the platform and enter the path to your NetBox installation, ending with `/oauth/complete/azuread-oauth2/`. Note that this URI **must** begin with `https://` unless you are referencing localhost (for development purposes).
-
-![App registration parameters](../../media/authentication/azure_ad_app_registration.png)
-
-Once finished, make note of the application (client) ID; this will be used when configuring NetBox.
-
-![Completed app registration](../../media/authentication/azure_ad_app_registration_created.png)
-
-!!! tip "Multitenant authentication"
-    NetBox also supports multitenant authentication via Azure AD, however it requires a different backend and an additional configuration parameter. Please see the [`python-social-auth` documentation](https://python-social-auth.readthedocs.io/en/latest/backends/azuread.html#tenant-support) for details concerning multitenant authentication.
-
-### 3. Create a secret
-
-When viewing the newly-created app registration, click the "Add a certificate or secret" link under "Client credentials". Under the "Client secrets" tab, click the "New client secret" button.
-
-![Add a client secret](../../media/authentication/azure_ad_add_client_secret.png)
-
-You can optionally specify a description and select a lifetime for the secret.
-
-![Client secret parameters](../../media/authentication/azure_ad_client_secret.png)
-
-Once finished, make note of the secret value (not the secret ID); this will be used when configuring NetBox.
-
-![Client secret parameters](../../media/authentication/azure_ad_client_secret_created.png)
-
-## NetBox Configuration
-
-### 1. Enter configuration parameters
-
-Enter the following configuration parameters in `configuration.py`, substituting your own values:
-
-```python
-REMOTE_AUTH_BACKEND = 'social_core.backends.azuread.AzureADOAuth2'
-SOCIAL_AUTH_AZUREAD_OAUTH2_KEY = '{APPLICATION_ID}'
-SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET = '{SECRET_VALUE}'
-```
-
-### 2. Restart NetBox
-
-Restart the NetBox services so that the new configuration takes effect. This is typically done with the command below:
-
-```no-highlight
-sudo systemctl restart netbox
-```
-
-## Testing
-
-Log out of NetBox if already authenticated, and click the "Log In" button at top right. You should see the normal login form as well as an option to authenticate using Azure AD. Click that link.
-
-![NetBox Azure AD login form](../../media/authentication/netbox_azure_ad_login.png)
-
-You should be redirected to Microsoft's authentication portal. Enter the username/email and password of your test account to continue. You may also be prompted to grant this application access to your account.
-
-![NetBox Azure AD login form](../../media/authentication/azure_ad_login_portal.png)
-
-If successful, you will be redirected back to the NetBox UI, and will be logged in as the AD user. You can verify this by navigating to your profile (using the button at top right).
-
-This user account has been replicated locally to NetBox, and can now be assigned groups and permissions within the NetBox admin UI.
-
-## Troubleshooting
-
-### Redirect URI does not Match
-
-Azure requires that the authenticating client request a redirect URI that matches what you've configured for the app in step two. This URI **must** begin with `https://` (unless using `localhost` for the domain).
-
-If Azure complains that the requested URI starts with `http://` (not HTTPS), it's likely that your HTTP server is misconfigured or sitting behind a load balancer, so NetBox is not aware that HTTPS is being use. To force the use of an HTTPS redirect URI, set `SOCIAL_AUTH_REDIRECT_IS_HTTPS = True` in `configuration.py` per the [python-social-auth docs](https://python-social-auth.readthedocs.io/en/latest/configuration/settings.html#processing-redirects-and-urlopen).
-
-### Not Logged in After Authenticating
-
-If you are redirected to the NetBox UI after authenticating successfully, but are _not_ logged in, double-check the configured backend and app registration. The instructions in this guide pertain only to the `azuread.AzureADOAuth2` backend using a single-tenant app registration.

docs/administration/authentication/okta.md

@@ -1,70 +0,0 @@
-# Okta
-
-This guide explains how to configure single sign-on (SSO) support for NetBox using [Okta](https://www.okta.com/) as an authentication backend.
-
-## Okta Configuration
-
-!!! tip "Okta developer account"
-    Okta offers free developer accounts at <https://developer.okta.com/>.
-
-### 1. Create a test user (optional)
-
-Create a new user in the Okta admin portal to be used for testing. You can skip this step if you already have a suitable account created.
-
-### 2. Create an app registration
-
-Within the Okta administration dashboard, navigate to  **Applications > Applications**, and click the "Create App Integration" button. Select "OIDC" as the sign-in method, and "Web application" for the application type.
-
-![Create an app registration](../../media/authentication/okta_create_app_registration.png)
-
-On the next page, give the app integration a name (e.g. "NetBox") and specify the sign-in and sign-out URIs. These URIs should follow the formats below:
-
-* Sign-in URI: `https://{netbox}/oauth/complete/okta-openidconnect/`
-* Sign-out URI: `https://{netbox}/oauth/disconnect/okta-openidconnect/`
-
-![Web app integration](../../media/authentication/okta_web_app_integration.png)
-
-Under "Assignments," select the controlled access setting most appropriate for your organization. Click "Save" to complete the creation.
-
-Once finished, note the following parameters. These will be used to configured NetBox.
-
-* Client ID
-* Client secret
-* Okta domain
-
-![Okta integration parameters](../../media/authentication/okta_integration_parameters.png)
-
-## NetBox Configuration
-
-### 1. Enter configuration parameters
-
-Enter the following configuration parameters in `configuration.py`, substituting your own values:
-
-```python
-REMOTE_AUTH_BACKEND = 'social_core.backends.okta_openidconnect.OktaOpenIdConnect'
-SOCIAL_AUTH_OKTA_OPENIDCONNECT_KEY = '{Client ID}'
-SOCIAL_AUTH_OKTA_OPENIDCONNECT_SECRET = '{Client secret}'
-SOCIAL_AUTH_OKTA_OPENIDCONNECT_API_URL = 'https://{Okta domain}/oauth2/'
-```
-
-### 2. Restart NetBox
-
-Restart the NetBox services so that the new configuration takes effect. This is typically done with the command below:
-
-```no-highlight
-sudo systemctl restart netbox
-```
-
-## Testing
-
-Log out of NetBox if already authenticated, and click the "Log In" button at top right. You should see the normal login form as well as an option to authenticate using Okta. Click that link.
-
-![NetBox Okta login form](../../media/authentication/netbox_okta_login.png)
-
-You should be redirected to Okta's authentication portal. Enter the username/email and password of your test account to continue. You may also be prompted to grant this application access to your account.
-
-![Okta login portal](../../media/authentication/okta_login_portal.png)
-
-If successful, you will be redirected back to the NetBox UI, and will be logged in as the Okta user. You can verify this by navigating to your profile (using the button at top right).
-
-This user account has been replicated locally to NetBox, and can now be assigned groups and permissions within the NetBox admin UI.

docs/administration/authentication/overview.md

@@ -1,37 +0,0 @@
-# Authentication
-
-## Local Authentication
-
-Local user accounts and groups can be created in NetBox under the "Authentication and Authorization" section of the administrative user interface. This interface is available only to users with the "staff" permission enabled.
-
-At a minimum, each user account must have a username and password set. User accounts may also denote a first name, last name, and email address. [Permissions](../permissions.md) may also be assigned to users and/or groups within the admin UI.
-
-## Remote Authentication
-
-NetBox may be configured to provide user authenticate via a remote backend in addition to local authentication. This is done by setting the `REMOTE_AUTH_BACKEND` configuration parameter to a suitable backend class. NetBox provides several options for remote authentication.
-
-### LDAP Authentication
-
-```python
-REMOTE_AUTH_BACKEND = 'netbox.authentication.LDAPBackend'
-```
-
-NetBox includes an authentication backend which supports LDAP. See the [LDAP installation docs](../../installation/6-ldap.md) for more detail about this backend.
-
-### HTTP Header Authentication
-
-```python
-REMOTE_AUTH_BACKEND = 'netbox.authentication.RemoteUserBackend'
-```
-
-Another option for remote authentication in NetBox is to enable HTTP header-based user assignment. The front end HTTP server (e.g. nginx or Apache) performs client authentication as a process external to NetBox, and passes information about the authenticated user via HTTP headers. By default, the user is assigned via the `REMOTE_USER` header, but this can be customized via the `REMOTE_AUTH_HEADER` configuration parameter.
-
-### Single Sign-On (SSO)
-
-```python
-REMOTE_AUTH_BACKEND = 'social_core.backends.google.GoogleOAuth2'
-```
-
-NetBox supports single sign-on authentication via the [python-social-auth](https://github.com/python-social-auth) library. To enable SSO, specify the path to the desired authentication backend within the `social_core` Python package. Please see the complete list of [supported authentication backends](https://github.com/python-social-auth/social-core/tree/master/social_core/backends) for the available options.
-
-Most remote authentication backends require some additional configuration through settings prefixed with `SOCIAL_AUTH_`. These will be automatically imported from NetBox's `configuration.py` file. Additionally, the [authentication pipeline](https://python-social-auth.readthedocs.io/en/latest/pipeline.html) can be customized via the `SOCIAL_AUTH_PIPELINE` parameter. (NetBox's default pipeline is defined in `netbox/settings.py` for your reference.)

docs/administration/error-reporting.md

@@ -1,46 +0,0 @@
-# Error Reporting
-
-## Sentry
-
-### Enabling Error Reporting
-
-NetBox v3.2.3 and later support native integration with [Sentry](https://sentry.io/) for automatic error reporting. To enable this functionality, simply set `SENTRY_ENABLED` to True in `configuration.py`. Errors will be sent to a Sentry ingestor maintained by the NetBox team for analysis.
-
-```python
-SENTRY_ENABLED = True
-```
-
-### Using a Custom DSN
-
-If you prefer instead to use your own Sentry ingestor, you'll need to first create a new project under your Sentry account to represent your NetBox deployment and obtain its corresponding data source name (DSN). This looks like a URL similar to the example below:
-
-```
-https://examplePublicKey@o0.ingest.sentry.io/0
-```
-
-Once you have obtained a DSN, configure Sentry in NetBox's `configuration.py` file with the following parameters:
-
-```python
-SENTRY_ENABLED = True
-SENTRY_DSN = "https://examplePublicKey@o0.ingest.sentry.io/0"
-```
-
-### Assigning Tags
-
-You can optionally attach one or more arbitrary tags to the outgoing error reports if desired by setting the `SENTRY_TAGS` parameter:
-
-```python
-SENTRY_TAGS = {
-    "custom.foo": "123",
-    "custom.bar": "abc",
-}
-```
-
-!!! warning "Reserved tag prefixes"
-    Avoid using any tag names which begin with `netbox.`, as this prefix is reserved by the NetBox application.
-
-### Testing
-
-Once the configuration has been saved, restart the NetBox service.
-
-To test Sentry operation, try generating a 404 (page not found) error by navigating to an invalid URL, such as `https://netbox/404-error-testing`. (Be sure that debug mode has been disabled.) After receiving a 404 response from the NetBox server, you should see the issue appear shortly in Sentry.

docs/administration/housekeeping.md

@@ -1,18 +0,0 @@
-# Housekeeping
-
-NetBox includes a `housekeeping` management command that should be run nightly. This command handles:
-
-* Clearing expired authentication sessions from the database
-* Deleting changelog records older than the configured [retention time](../configuration/miscellaneous.md#changelog_retention)
-* Deleting job result records older than the configured [retention time](../configuration/miscellaneous.md#jobresult_retention)
-
-This command can be invoked directly, or by using the shell script provided at `/opt/netbox/contrib/netbox-housekeeping.sh`. This script can be linked from your cron scheduler's daily jobs directory (e.g. `/etc/cron.daily`) or referenced directly within the cron configuration file.
-
-```shell
-sudo ln -s /opt/netbox/contrib/netbox-housekeeping.sh /etc/cron.daily/netbox-housekeeping
-```
-
-!!! note
-    On Debian-based systems, be sure to omit the `.sh` file extension when linking to the script from within a cron directory. Otherwise, the task may not run.
-
-The `housekeeping` command can also be run manually at any time: Running the command outside scheduled execution times will not interfere with its operation.

docs/administration/permissions.md

@@ -1,112 +0,0 @@
-# Object-Based Permissions
-
-NetBox v2.9 introduced a new object-based permissions framework, which replaces Django's built-in permissions model. Object-based permissions enable an administrator to grant users or groups the ability to perform an action on arbitrary subsets of objects in NetBox, rather than all objects of a certain type. For example, it is possible to grant a user permission to view only sites within a particular region, or to modify only VLANs with a numeric ID within a certain range.
-
-A permission in NetBox represents a relationship shared by several components:
-
-* Object type(s) - One or more types of object in NetBox
-* User(s)/Group(s) - One or more users or groups of users
-* Action(s) - The action(s) that can be performed on an object
-* Constraints - An arbitrary filter used to limit the granted action(s) to a specific subset of objects
-
-At a minimum, a permission assignment must specify one object type, one user or group, and one action. The specification of constraints is optional: A permission without any constraints specified will apply to all instances of the selected model(s).
-
-## Actions
-
-There are four core actions that can be permitted for each type of object within NetBox, roughly analogous to the CRUD convention (create, read, update, and delete):
-
-* **View** - Retrieve an object from the database
-* **Add** - Create a new object
-* **Change** - Modify an existing object
-* **Delete** - Delete an existing object
-
-In addition to these, permissions can also grant custom actions that may be required by a specific model or plugin. For example, the `napalm_read` permission on the device model allows a user to execute NAPALM queries on a device via NetBox's REST API. These can be specified when granting a permission in the "additional actions" field.
-
-!!! note
-    Internally, all actions granted by a permission (both built-in and custom) are stored as strings in an array field named `actions`.
-
-## Constraints
-
-Constraints are expressed as a JSON object or list representing a [Django query filter](https://docs.djangoproject.com/en/stable/ref/models/querysets/#field-lookups). This is the same syntax that you would pass to the QuerySet `filter()` method when performing a query using the Django ORM. As with query filters, double underscores can be used to traverse related objects or invoke lookup expressions. Some example queries and their corresponding definitions are shown below.
-
-All attributes defined within a single JSON object are applied with a logical AND. For example, suppose you assign a permission for the site model with the following constraints.
-
-```json
-{
-  "status": "active",
-  "region__name": "Americas"
-}
-```
-
-The permission will grant access only to sites which have a status of "active" **and** which are assigned to the "Americas" region.
-
-To achieve a logical OR with a different set of constraints, define multiple objects within a list. For example, if you want to constrain the permission to VLANs with an ID between 100 and 199 _or_ a status of "reserved," do the following:
-
-```json
-[
-  {
-    "vid__gte": 100,
-    "vid__lt": 200
-  },
-  {
-    "status": "reserved"
-  }
-]
-```
-
-Additionally, where multiple permissions have been assigned for an object type, their collective constraints will be merged using a logical "OR" operation.
-
-### User Token
-
-!!! info "This feature was introduced in NetBox v3.3"
-
-When defining a permission constraint, administrators may use the special token `$user` to reference the current user at the time of evaluation. This can be helpful to restrict users to editing only their own journal entries, for example. Such a constraint might be defined as:
-
-```json
-{
-  "created_by": "$user"
-}
-```
-
-The `$user` token can be used only as a constraint value, or as an item within a list of values. It cannot be modified or extended to reference specific user attributes.
-
-
-#### Example Constraint Definitions
-
-| Constraints | Description |
-| ----------- | ----------- |
-| `{"status": "active"}` | Status is active |
-| `{"status__in": ["planned", "reserved"]}` | Status is active **OR** reserved |
-| `{"status": "active", "role": "testing"}` | Status is active **AND** role is testing |
-| `{"name__startswith": "Foo"}` | Name starts with "Foo" (case-sensitive) |
-| `{"name__iendswith": "bar"}` | Name ends with "bar" (case-insensitive) |
-| `{"vid__gte": 100, "vid__lt": 200}` | VLAN ID is greater than or equal to 100 **AND** less than 200 |
-| `[{"vid__lt": 200}, {"status": "reserved"}]` | VLAN ID is less than 200 **OR** status is reserved |
-
-## Permissions Enforcement
-
-### Viewing Objects
-
-Object-based permissions work by filtering the database query generated by a user's request to restrict the set of objects returned. When a request is received, NetBox first determines whether the user is authenticated and has been granted to perform the requested action. For example, if the requested URL is `/dcim/devices/`, NetBox will check for the `dcim.view_device` permission. If the user has not been assigned this permission (either directly or via a group assignment), NetBox will return a 403 (forbidden) HTTP response.
-
-If the permission _has_ been granted, NetBox will compile any specified constraints for the model and action. For example, suppose two permissions have been assigned to the user granting view access to the device model, with the following constraints:
-
-```json
-[
-    {"site__name__in":  ["NYC1", "NYC2"]},
-    {"status":  "offline", "tenant__isnull":  true}
-]
-```
-
-This grants the user access to view any device that is assigned to a site named NYC1 or NYC2, **or** which has a status of "offline" and has no tenant assigned. These constraints are equivalent to the following ORM query:
-
-```no-highlight
-Site.objects.filter(
-    Q(site__name__in=['NYC1', 'NYC2']),
-    Q(status='active', tenant__isnull=True)
-)
-```
-
-### Creating and Modifying Objects
-
-The same sort of logic is in play when a user attempts to create or modify an object in NetBox, with a twist. Once validation has completed, NetBox starts an atomic database transaction to facilitate the change, and the object is created or saved normally. Next, still within the transaction, NetBox issues a second query to retrieve the newly created/updated object, filtering the restricted queryset with the object's primary key. If this query fails to return the object, NetBox knows that the new revision does not match the constraints imposed by the permission. The transaction is then rolled back, leaving the database in its original state prior to the change, and the user is informed of the violation.

docs/administration/replicating-netbox.md

@@ -1,73 +0,0 @@
-# Replicating NetBox
-
-## Replicating the Database
-
-NetBox employs a [PostgreSQL](https://www.postgresql.org/) database, so general PostgreSQL best practices apply here. The database can be written to a file and restored using the `pg_dump` and `psql` utilities, respectively.
-
-!!! note
-    The examples below assume that your database is named `netbox`.
-
-### Export the Database
-
-Use the `pg_dump` utility to export the entire database to a file:
-
-```no-highlight
-pg_dump --username netbox --password --host localhost netbox > netbox.sql
-```
-
-!!! note
-    You may need to change the username, host, and/or database in the command above to match your installation.
-
-When replicating a production database for development purposes, you may find it convenient to exclude changelog data, which can easily account for the bulk of a database's size. To do this, exclude the `extras_objectchange` table data from the export. The table will still be included in the output file, but will not be populated with any data.
-
-```no-highlight
-pg_dump ... --exclude-table-data=extras_objectchange netbox > netbox.sql
-```
-
-### Load an Exported Database
-
-When restoring a database from a file, it's recommended to delete any existing database first to avoid potential conflicts.
-
-!!! warning
-    The following will destroy and replace any existing instance of the database.
-
-```no-highlight
-psql -c 'drop database netbox'
-psql -c 'create database netbox'
-psql netbox < netbox.sql
-```
-
-Keep in mind that PostgreSQL user accounts and permissions are not included with the dump: You will need to create those manually if you want to fully replicate the original database (see the [installation docs](../installation/1-postgresql.md)). When setting up a development instance of NetBox, it's strongly recommended to use different credentials anyway.
-
-### Export the Database Schema
-
-If you want to export only the database schema, and not the data itself (e.g. for development reference), do the following:
-
-```no-highlight
-pg_dump --username netbox --password --host localhost -s netbox > netbox_schema.sql
-```
-
----
-
-## Replicating Uploaded Media
-
-By default, NetBox stores uploaded files (such as image attachments) in its media directory. To fully replicate an instance of NetBox, you'll need to copy both the database and the media files.
-
-!!! note
-    These operations are not necessary if your installation is utilizing a [remote storage backend](../../configuration/optional-settings/#storage_backend).
-
-### Archive the Media Directory
-
-Execute the following command from the root of the NetBox installation path (typically `/opt/netbox`):
-
-```no-highlight
-tar -czf netbox_media.tar.gz netbox/media/
-```
-
-### Restore the Media Directory
-
-To extract the saved archive into a new installation, run the following from the installation root:
-
-```no-highlight
-tar -xf netbox_media.tar.gz
-```

docs/api/authentication.md

@@ -0,0 +1,48 @@
+The NetBox API employs token-based authentication. For convenience, cookie authentication can also be used when navigating the browsable API.
+
+# Tokens
+
+A token is a unique identifier that identifies a user to the API. Each user in NetBox may have one or more tokens which he or she can use to authenticate to the API. To create a token, navigate to the API tokens page at `/user/api-tokens/`.
+
+Each token contains a 160-bit key represented as 40 hexadecimal characters. When creating a token, you'll typically leave the key field blank so that a random key will be automatically generated. However, NetBox allows you to specify a key in case you need to restore a previously deleted token to operation.
+
+By default, a token can be used for all operations available via the API. Deselecting the "write enabled" option will restrict API requests made with the token to read operations (e.g. GET) only.
+
+Additionally, a token can be set to expire at a specific time. This can be useful if an external client needs to be granted temporary access to NetBox.
+
+# Authenticating to the API
+
+By default, read operations will be available without authentication. In this case, a token may be included in the request, but is not necessary.
+
+```
+$ curl -H "Accept: application/json; indent=4" http://localhost/api/dcim/sites/
+{
+    "count": 10,
+    "next": null,
+    "previous": null,
+    "results": [...]
+}
+```
+
+However, if the [`LOGIN_REQUIRED`](../configuration/optional-settings/#login_required) configuration setting has been set to `True`, all requests must be authenticated.
+
+```
+$ curl -H "Accept: application/json; indent=4" http://localhost/api/dcim/sites/
+{
+    "detail": "Authentication credentials were not provided."
+}
+```
+
+To authenticate to the API, set the HTTP `Authorization` header to the string `Token ` (note the trailing space) followed by the token key.
+
+```
+$ curl -H "Authorization: Token d2f763479f703d80de0ec15254237bc651f9cdc0" -H "Accept: application/json; indent=4" http://localhost/api/dcim/sites/
+{
+    "count": 10,
+    "next": null,
+    "previous": null,
+    "results": [...]
+}
+```
+
+Additionally, the browsable interface to the API (which can be seen by navigating to the API root `/api/` in a web browser) will attempt to authenticate requests using the same cookie that the normal NetBox front end uses. Thus, if you have logged into NetBox, you will be logged into the browsable API as well.

docs/api/examples.md

@@ -0,0 +1,146 @@
+# API Examples
+
+Supported HTTP methods:
+
+* `GET`: Retrieve an object or list of objects
+* `POST`: Create a new object
+* `PUT`: Update an existing object, all mandatory fields must be specified
+* `PATCH`: Updates an existing object, only specifiying the field to be changed
+* `DELETE`: Delete an existing object
+
+To authenticate a request, attach your token in an `Authorization` header:
+
+```
+curl -H "Authorization: Token d2f763479f703d80de0ec15254237bc651f9cdc0"
+```
+
+### Retrieving a list of sites
+
+Send a `GET` request to the object list endpoint. The response contains a paginated list of JSON objects.
+
+```
+$ curl -H "Accept: application/json; indent=4" http://localhost/api/dcim/sites/
+{
+    "count": 14,
+    "next": null,
+    "previous": null,
+    "results": [
+        {
+            "id": 6,
+            "name": "Corporate HQ",
+            "slug": "corporate-hq",
+            "region": null,
+            "tenant": null,
+            "facility": "",
+            "asn": null,
+            "physical_address": "742 Evergreen Terrace, Springfield, USA",
+            "shipping_address": "",
+            "contact_name": "",
+            "contact_phone": "",
+            "contact_email": "",
+            "comments": "",
+            "custom_fields": {},
+            "count_prefixes": 108,
+            "count_vlans": 46,
+            "count_racks": 8,
+            "count_devices": 254,
+            "count_circuits": 6
+        },
+        ...
+    ]
+}
+```
+
+### Retrieving a single site by ID
+
+Send a `GET` request to the object detail endpoint. The response contains a single JSON object.
+
+```
+$ curl -H "Accept: application/json; indent=4" http://localhost/api/dcim/sites/6/
+{
+    "id": 6,
+    "name": "Corporate HQ",
+    "slug": "corporate-hq",
+    "region": null,
+    "tenant": null,
+    "facility": "",
+    "asn": null,
+    "physical_address": "742 Evergreen Terrace, Springfield, USA",
+    "shipping_address": "",
+    "contact_name": "",
+    "contact_phone": "",
+    "contact_email": "",
+    "comments": "",
+    "custom_fields": {},
+    "count_prefixes": 108,
+    "count_vlans": 46,
+    "count_racks": 8,
+    "count_devices": 254,
+    "count_circuits": 6
+}
+```
+
+### Creating a new site
+
+Send a `POST` request to the site list endpoint with token authentication and JSON-formatted data. Only mandatory fields are required.
+
+```
+$ curl -X POST -H "Authorization: Token d2f763479f703d80de0ec15254237bc651f9cdc0" -H "Content-Type: application/json" -H "Accept: application/json; indent=4" http://localhost:8000/api/dcim/sites/ --data '{"name": "My New Site", "slug": "my-new-site"}'
+{
+    "id": 16,
+    "name": "My New Site",
+    "slug": "my-new-site",
+    "region": null,
+    "tenant": null,
+    "facility": "",
+    "asn": null,
+    "physical_address": "",
+    "shipping_address": "",
+    "contact_name": "",
+    "contact_phone": "",
+    "contact_email": "",
+    "comments": ""
+}
+```
+
+### Modify an existing site
+
+Make an authenticated `PUT` request to the site detail endpoint. As with a create (`POST`) request, all mandatory fields must be included.
+
+```
+$ curl -X PUT -H "Authorization: Token d2f763479f703d80de0ec15254237bc651f9cdc0" -H "Content-Type: application/json" -H "Accept: application/json; indent=4" http://localhost:8000/api/dcim/sites/16/ --data '{"name": "Renamed Site", "slug": "renamed-site"}'
+```
+
+### Modify an object by changing a field
+
+Make an authenticated `PATCH` request to the device endpoint. With `PATCH`, unlike `POST` and `PUT`, we only specify the field that is being changed. In this example, we add a serial number to a device.
+```
+$ curl -X PATCH -H "Authorization: Token d2f763479f703d80de0ec15254237bc651f9cdc0" -H "Content-Type: application/json" -H "Accept: application/json; indent=4" http://localhost:8000/api/dcim/devices/2549/ --data '{"serial": "FTX1123A090"}'
+```
+
+### Delete an existing site
+
+Send an authenticated `DELETE` request to the site detail endpoint.
+
+```
+$ curl -v X DELETE -H "Authorization: Token d2f763479f703d80de0ec15254237bc651f9cdc0" -H "Content-Type: application/json" -H "Accept: application/json; indent=4" http://localhost:8000/api/dcim/sites/16/
+* Connected to localhost (127.0.0.1) port 8000 (#0)
+> DELETE /api/dcim/sites/16/ HTTP/1.1
+> User-Agent: curl/7.35.0
+> Host: localhost:8000
+> Authorization: Token d2f763479f703d80de0ec15254237bc651f9cdc0
+> Content-Type: application/json
+> Accept: application/json; indent=4
+>
+* HTTP 1.0, assume close after body
+< HTTP/1.0 204 No Content
+< Date: Mon, 20 Mar 2017 16:13:08 GMT
+< Server: WSGIServer/0.1 Python/2.7.6
+< Vary: Accept, Cookie
+< X-Frame-Options: SAMEORIGIN
+< Allow: GET, PUT, PATCH, DELETE, OPTIONS
+<
+* Closing connection 0
+```
+
+The response to a successfull `DELETE` request will have code 204 (No Content); the body of the response will be empty.

docs/api/overview.md

@@ -0,0 +1,177 @@
+NetBox v2.0 and later includes a full-featured REST API that allows its data model to be read and manipulated externally.
+
+# What is a REST API?
+
+REST stands for [representational state transfer](https://en.wikipedia.org/wiki/Representational_state_transfer). It's a particular type of API which employs HTTP to create, retrieve, update, and delete objects from a database. (This set of operations is commonly referred to as CRUD.) Each type of operation is associated with a particular HTTP verb:
+
+* `GET`: Retrieve an object or list of objects
+* `POST`: Create an object
+* `PUT` / `PATCH`: Modify an existing object. `PUT` requires all mandatory fields to be specified, while `PATCH` only expects the field that is being modified to be specified.
+* `DELETE`: Delete an existing object
+
+The NetBox API represents all objects in [JavaScript Object Notation (JSON)](http://www.json.org/). This makes it very easy to interact with NetBox data on the command line with common tools. For example, we can request an IP address from NetBox and output the JSON using `curl` and `jq`. (Piping the output through `jq` isn't strictly required but makes it much easier to read.)
+
+```
+$ curl -s http://localhost:8000/api/ipam/ip-addresses/2954/ | jq '.'
+{
+  "custom_fields": {},
+  "nat_outside": null,
+  "nat_inside": null,
+  "description": "An example IP address",
+  "id": 2954,
+  "family": 4,
+  "address": "5.101.108.132/26",
+  "vrf": null,
+  "tenant": null,
+  "status": {
+    "label": "Active",
+    "value": 1
+  },
+  "role": null,
+  "interface": null
+}
+```
+
+Each attribute of the NetBox object is expressed as a field in the dictionary. Fields may include their own nested objects, as in the case of the `status` field above. Every object includes a primary key named `id` which uniquely identifies it in the database.
+
+# URL Hierarchy
+
+NetBox's entire API is housed under the API root at `https://<hostname>/api/`. The URL structure is divided at the root level by application: circuits, DCIM, extras, IPAM, secrets, and tenancy. Within each application, each model has its own path. For example, the provider and circuit objects are located under the "circuits" application:
+
+* /api/circuits/providers/
+* /api/circuits/circuits/
+
+Likewise, the site, rack, and device objects are located under the "DCIM" application:
+
+* /api/dcim/sites/
+* /api/dcim/racks/
+* /api/dcim/devices/
+
+The full hierarchy of available endpoints can be viewed by navigating to the API root in a web browser.
+
+Each model generally has two views associated with it: a list view and a detail view. The list view is used to request a list of multiple objects or to create a new object. The detail view is used to retrieve, update, or delete an existing object. All objects are referenced by their numeric primary key (`id`).
+
+* /api/dcim/devices/ - List devices or create a new device
+* /api/dcim/devices/123/ - Retrieve, update, or delete the device with ID 123
+
+Lists of objects can be filtered using a set of query parameters. For example, to find all interfaces belonging to the device with ID 123:
+
+```
+GET /api/dcim/interfaces/?device_id=123
+```
+
+# Serialization
+
+The NetBox API employs three types of serializers to represent model data:
+
+* Base serializer
+* Nested serializer
+* Writable serializer
+
+The base serializer is used to represent the default view of a model. This includes all database table fields which comprise the model, and may include additional metadata. A base serializer includes relationships to parent objects, but **does not** include child objects. For example, the `VLANSerializer` includes a nested representation its parent VLANGroup (if any), but does not include any assigned Prefixes.
+
+```
+{
+    "id": 1048,
+    "site": {
+        "id": 7,
+        "url": "http://localhost:8000/api/dcim/sites/7/",
+        "name": "Corporate HQ",
+        "slug": "corporate-hq"
+    },
+    "group": {
+        "id": 4,
+        "url": "http://localhost:8000/api/ipam/vlan-groups/4/",
+        "name": "Production",
+        "slug": "production"
+    },
+    "vid": 101,
+    "name": "Users-Floor1",
+    "tenant": null,
+    "status": [
+        1,
+        "Active"
+    ],
+    "role": {
+        "id": 9,
+        "url": "http://localhost:8000/api/ipam/roles/9/",
+        "name": "User Access",
+        "slug": "user-access"
+    },
+    "description": "",
+    "display_name": "101 (Users-Floor1)",
+    "custom_fields": {}
+}
+```
+
+Related objects (e.g. `ForeignKey` fields) are represented using a nested serializer. A nested serializer provides a minimal representation of an object, including only its URL and enough information to construct its name.
+
+When a base serializer includes one or more nested serializers, the hierarchical structure precludes it from being used for write operations. Thus, a flat representation of an object may be provided using a writable serializer. This serializer includes only raw database values and is not typically used for retrieval, except as part of the response to the creation or updating of an object.
+
+```
+{
+    "id": 1201,
+    "site": 7,
+    "group": 4,
+    "vid": 102,
+    "name": "Users-Floor2",
+    "tenant": null,
+    "status": 1,
+    "role": 9,
+    "description": ""
+}
+```
+
+# Pagination
+
+API responses which contain a list of objects (for example, a request to `/api/dcim/devices/`) will be paginated to avoid unnecessary overhead. The root JSON object will contain the following attributes:
+
+* `count`: The total count of all objects matching the query
+* `next`: A hyperlink to the next page of results (if applicable)
+* `previous`: A hyperlink to the previous page of results (if applicable)
+* `results`: The list of returned objects
+
+Here is an example of a paginated response:
+
+```
+HTTP 200 OK
+Allow: GET, POST, OPTIONS
+Content-Type: application/json
+Vary: Accept
+
+{
+    "count": 2861,
+    "next": "http://localhost:8000/api/dcim/devices/?limit=50&offset=50",
+    "previous": null,
+    "results": [
+        {
+            "id": 123,
+            "name": "DeviceName123",
+            ...
+        },
+        ...
+    ]
+}
+```
+
+The default page size derives from the [`PAGINATE_COUNT`](../configuration/optional-settings/#paginate_count) configuration setting, which defaults to 50. However, this can be overridden per request by specifying the desired `offset` and `limit` query parameters. For example, if you wish to retrieve a hundred devices at a time, you would make a request for:
+
+```
+http://localhost:8000/api/dcim/devices/?limit=100
+```
+
+The response will return devices 1 through 100. The URL provided in the `next` attribute of the response will return devices 101 through 200:
+
+```
+{
+    "count": 2861,
+    "next": "http://localhost:8000/api/dcim/devices/?limit=100&offset=100",
+    "previous": null,
+    "results": [...]
+}
+```
+
+The maximum number of objects that can be returned is limited by the [`MAX_PAGE_SIZE`](../configuration/optional-settings/#max_page_size) setting, which is 1000 by default. Setting this to `0` or `None` will remove the maximum limit. An API consumer can then pass `?limit=0` to retrieve _all_ matching objects with a single request.
+
+!!! warning
+    Disabling the page size limit introduces a potential for very resource-intensive requests, since one API request can effectively retrieve an entire table from the database.

docs/api/working-with-secrets.md

@@ -0,0 +1,136 @@
+As with most other objects, the NetBox API can be used to create, modify, and delete secrets. However, additional steps are needed to encrypt or decrypt secret data.
+
+# Generating a Session Key
+
+In order to encrypt or decrypt secret data, a session key must be attached to the API request. To generate a session key, send an authenticated request to the `/api/secrets/get-session-key/` endpoint with the private RSA key which matches your [UserKey](../data-model/secrets/#user-keys). The private key must be POSTed with the name `private_key`.
+
+```
+$ curl -X POST http://localhost:8000/api/secrets/get-session-key/ \
+-H "Authorization: Token c639d619ecbeb1f3055c4141ba6870e20572edd7" \
+-H "Accept: application/json; indent=4" \
+--data-urlencode "private_key@<filename>"
+{
+    "session_key": "dyEnxlc9lnGzaOAV1dV/xqYPV63njIbdZYOgnAlGPHk="
+}
+```
+
+!!! note
+    To read the private key from a file, use the convention above. Alternatively, the private key can be read from an environment variable using `--data-urlencode "private_key=$PRIVATE_KEY"`.
+
+The request uses your private key to unlock your stored copy of the master key and generate a session key which can be attached in the `X-Session-Key` header of future API requests.
+
+# Retrieving Secrets
+
+A session key is not needed to retrieve unencrypted secrets: The secret is returned like any normal object with its `plaintext` field set to null.
+
+```
+$ curl http://localhost:8000/api/secrets/secrets/2587/ \
+-H "Authorization: Token c639d619ecbeb1f3055c4141ba6870e20572edd7" \
+-H "Accept: application/json; indent=4"
+{
+    "id": 2587,
+    "device": {
+        "id": 1827,
+        "url": "http://localhost:8000/api/dcim/devices/1827/",
+        "name": "MyTestDevice",
+        "display_name": "MyTestDevice"
+    },
+    "role": {
+        "id": 1,
+        "url": "http://localhost:8000/api/secrets/secret-roles/1/",
+        "name": "Login Credentials",
+        "slug": "login-creds"
+    },
+    "name": "admin",
+    "plaintext": null,
+    "hash": "pbkdf2_sha256$1000$G6mMFe4FetZQ$f+0itZbAoUqW5pd8+NH8W5rdp/2QNLIBb+LGdt4OSKA=",
+    "created": "2017-03-21",
+    "last_updated": "2017-03-21T19:28:44.265582Z"
+}
+```
+
+To decrypt a secret, we must include our session key in the `X-Session-Key` header:
+
+```
+$ curl http://localhost:8000/api/secrets/secrets/2587/ \
+-H "Authorization: Token c639d619ecbeb1f3055c4141ba6870e20572edd7" \
+-H "Accept: application/json; indent=4" \
+-H "X-Session-Key: dyEnxlc9lnGzaOAV1dV/xqYPV63njIbdZYOgnAlGPHk="
+{
+    "id": 2587,
+    "device": {
+        "id": 1827,
+        "url": "http://localhost:8000/api/dcim/devices/1827/",
+        "name": "MyTestDevice",
+        "display_name": "MyTestDevice"
+    },
+    "role": {
+        "id": 1,
+        "url": "http://localhost:8000/api/secrets/secret-roles/1/",
+        "name": "Login Credentials",
+        "slug": "login-creds"
+    },
+    "name": "admin",
+    "plaintext": "foobar",
+    "hash": "pbkdf2_sha256$1000$G6mMFe4FetZQ$f+0itZbAoUqW5pd8+NH8W5rdp/2QNLIBb+LGdt4OSKA=",
+    "created": "2017-03-21",
+    "last_updated": "2017-03-21T19:28:44.265582Z"
+}
+```
+
+Lists of secrets can be decrypted in this manner as well:
+
+```
+$ curl http://localhost:8000/api/secrets/secrets/?limit=3 \
+-H "Authorization: Token c639d619ecbeb1f3055c4141ba6870e20572edd7" \
+-H "Accept: application/json; indent=4" \
+-H "X-Session-Key: dyEnxlc9lnGzaOAV1dV/xqYPV63njIbdZYOgnAlGPHk="
+{
+    "count": 3482,
+    "next": "http://localhost:8000/api/secrets/secrets/?limit=3&offset=3",
+    "previous": null,
+    "results": [
+        {
+            "id": 2587,
+            ...
+            "plaintext": "foobar",
+            ...
+        },
+        {
+            "id": 2588,
+            ...
+            "plaintext": "MyP@ssw0rd!",
+            ...
+        },
+        {
+            "id": 2589,
+            ...
+            "plaintext": "AnotherSecret!",
+            ...
+        },
+    ]
+}
+```
+
+# Creating Secrets
+
+Session keys are also used to decrypt new or modified secrets. This is done by setting the `plaintext` field of the submitted object:
+
+```
+$ curl -X POST http://localhost:8000/api/secrets/secrets/ \
+-H "Content-Type: application/json" \
+-H "Authorization: Token c639d619ecbeb1f3055c4141ba6870e20572edd7" \
+-H "Accept: application/json; indent=4" \
+-H "X-Session-Key: dyEnxlc9lnGzaOAV1dV/xqYPV63njIbdZYOgnAlGPHk=" \
+--data '{"device": 1827, "role": 1, "name": "backup", "plaintext": "Drowssap1"}'
+{
+    "id": 2590,
+    "device": 1827,
+    "role": 1,
+    "name": "backup",
+    "plaintext": "Drowssap1"
+}
+```
+
+!!! note
+    Don't forget to include the `Content-Type: application/json` header when making a POST request.

docs/configuration/data-validation.md

@@ -1,86 +0,0 @@
-# Data & Validation Parameters
-
-## CUSTOM_VALIDATORS
-
-!!! tip "Dynamic Configuration Parameter"
-
-This is a mapping of models to [custom validators](../customization/custom-validation.md) that have been defined locally to enforce custom validation logic. An example is provided below:
-
-```python
-CUSTOM_VALIDATORS = {
-    "dcim.site": [
-        {
-            "name": {
-                "min_length": 5,
-                "max_length": 30
-            }
-        },
-        "my_plugin.validators.Validator1"
-    ],
-    "dim.device": [
-        "my_plugin.validators.Validator1"
-    ]
-}
-```
-
----
-
-## FIELD_CHOICES
-
-Some static choice fields on models can be configured with custom values. This is done by defining `FIELD_CHOICES` as a dictionary mapping model fields to their choices. Each choice in the list must have a database value and a human-friendly label, and may optionally specify a color. (A list of available colors is provided below.)
-
-The choices provided can either replace the stock choices provided by NetBox, or append to them. To _replace_ the available choices, specify the app, model, and field name separated by dots. For example, the site model would be referenced as `dcim.Site.status`. To _extend_ the available choices, append a plus sign to the end of this string (e.g. `dcim.Site.status+`).
-
-For example, the following configuration would replace the default site status choices with the options Foo, Bar, and Baz:
-
-```python
-FIELD_CHOICES = {
-    'dcim.Site.status': (
-        ('foo', 'Foo', 'red'),
-        ('bar', 'Bar', 'green'),
-        ('baz', 'Baz', 'blue'),
-    )
-}
-```
-
-Appending a plus sign to the field identifier would instead _add_ these choices to the ones already offered:
-
-```python
-FIELD_CHOICES = {
-    'dcim.Site.status+': (
-        ...
-    )
-}
-```
-
-The following model fields support configurable choices:
-
-* `circuits.Circuit.status`
-* `dcim.Device.status`
-* `dcim.Location.status`
-* `dcim.PowerFeed.status`
-* `dcim.Rack.status`
-* `dcim.Site.status`
-* `extras.JournalEntry.kind`
-* `ipam.IPAddress.status`
-* `ipam.IPRange.status`
-* `ipam.Prefix.status`
-* `ipam.VLAN.status`
-* `virtualization.Cluster.status`
-* `virtualization.VirtualMachine.status`
-
-The following colors are supported:
-
-* `blue`
-* `indigo`
-* `purple`
-* `pink`
-* `red`
-* `orange`
-* `yellow`
-* `green`
-* `teal`
-* `cyan`
-* `gray`
-* `black`
-* `white`

docs/configuration/date-time.md

@@ -1,20 +0,0 @@
-# Date & Time Parameters
-
-## TIME_ZONE
-
-Default: UTC
-
-The time zone NetBox will use when dealing with dates and times. It is recommended to use UTC time unless you have a specific need to use a local time zone. Please see the [list of available time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
-
-## Date and Time Formatting
-
-You may define custom formatting for date and times. For detailed instructions on writing format strings, please see [the Django documentation](https://docs.djangoproject.com/en/stable/ref/templates/builtins/#date). Default formats are listed below.
-
-```python
-DATE_FORMAT = 'N j, Y'               # June 26, 2016
-SHORT_DATE_FORMAT = 'Y-m-d'          # 2016-06-26
-TIME_FORMAT = 'g:i a'                # 1:23 p.m.
-SHORT_TIME_FORMAT = 'H:i:s'          # 13:23:00
-DATETIME_FORMAT = 'N j, Y g:i a'     # June 26, 2016 1:23 p.m.
-SHORT_DATETIME_FORMAT = 'Y-m-d H:i'  # 2016-06-26 13:23
-```

docs/configuration/default-values.md

@@ -1,77 +0,0 @@
-# Default Value Parameters
-
-## DEFAULT_USER_PREFERENCES
-
-!!! tip "Dynamic Configuration Parameter"
-
-This is a dictionary defining the default preferences to be set for newly-created user accounts. For example, to set the default page size for all users to 100, define the following:
-
-```python
-DEFAULT_USER_PREFERENCES = {
-    "pagination": {
-        "per_page": 100
-    }
-}
-```
-
-For a complete list of available preferences, log into NetBox and navigate to `/user/preferences/`. A period in a preference name indicates a level of nesting in the JSON data. The example above maps to `pagination.per_page`.
-
----
-
-## PAGINATE_COUNT
-
-!!! tip "Dynamic Configuration Parameter"
-
-Default: 50
-
-The default maximum number of objects to display per page within each list of objects.
-
----
-
-## POWERFEED_DEFAULT_AMPERAGE
-
-!!! tip "Dynamic Configuration Parameter"
-
-Default: 15
-
-The default value for the `amperage` field when creating new power feeds.
-
----
-
-## POWERFEED_DEFAULT_MAX_UTILIZATION
-
-!!! tip "Dynamic Configuration Parameter"
-
-Default: 80
-
-The default value (percentage) for the `max_utilization` field when creating new power feeds.
-
----
-
-## POWERFEED_DEFAULT_VOLTAGE
-
-!!! tip "Dynamic Configuration Parameter"
-
-Default: 120
-
-The default value for the `voltage` field when creating new power feeds.
-
----
-
-## RACK_ELEVATION_DEFAULT_UNIT_HEIGHT
-
-!!! tip "Dynamic Configuration Parameter"
-
-Default: 22
-
-Default height (in pixels) of a unit within a rack elevation. For best results, this should be approximately one tenth of `RACK_ELEVATION_DEFAULT_UNIT_WIDTH`.
-
----
-
-## RACK_ELEVATION_DEFAULT_UNIT_WIDTH
-
-!!! tip "Dynamic Configuration Parameter"
-
-Default: 220
-
-Default width (in pixels) of a unit within a rack elevation.

docs/configuration/development.md

@@ -1,21 +0,0 @@
-# Development Parameters
-
-## DEBUG
-
-Default: False
-
-This setting enables debugging. Debugging should be enabled only during development or troubleshooting. Note that only
-clients which access NetBox from a recognized [internal IP address](#internal_ips) will see debugging tools in the user
-interface.
-
-!!! warning
-    Never enable debugging on a production system, as it can expose sensitive data to unauthenticated users and impose a
-    substantial performance penalty.
-
----
-
-## DEVELOPER
-
-Default: False
-
-This parameter serves as a safeguard to prevent some potentially dangerous behavior, such as generating new database schema migrations. Set this to `True` **only** if you are actively developing the NetBox code base.

docs/configuration/error-reporting.md

@@ -1,54 +0,0 @@
-# Error Reporting Settings
-
-## SENTRY_DSN
-
-Default: None
-
-Defines a Sentry data source name (DSN) for automated error reporting. `SENTRY_ENABLED` must be True for this parameter to take effect. For example:
-
-```
-SENTRY_DSN = "https://examplePublicKey@o0.ingest.sentry.io/0"
-```
-
----
-
-## SENTRY_ENABLED
-
-Default: False
-
-Set to True to enable automatic error reporting via [Sentry](https://sentry.io/).
-
----
-
-## SENTRY_SAMPLE_RATE
-
-Default: 1.0 (all)
-
-The sampling rate for errors. Must be a value between 0 (disabled) and 1.0 (report on all errors).
-
----
-
-## SENTRY_TAGS
-
-An optional dictionary of tag names and values to apply to Sentry error reports.For example:
-
-```
-SENTRY_TAGS = {
-    "custom.foo": "123",
-    "custom.bar": "abc",
-}
-```
-
-!!! warning "Reserved tag prefixes"
-    Avoid using any tag names which begin with `netbox.`, as this prefix is reserved by the NetBox application.
-
----
-
-## SENTRY_TRACES_SAMPLE_RATE
-
-Default: 0 (disabled)
-
-The sampling rate for transactions. Must be a value between 0 (disabled) and 1.0 (report on all transactions).
-
-!!! warning "Consider performance implications"
-    A high sampling rate for transactions can induce significant performance penalties. If transaction reporting is desired, it is recommended to use a relatively low sample rate of 10% to 20% (0.1 to 0.2).

docs/configuration/index.md

@@ -1,53 +0,0 @@
-# NetBox Configuration
-
-## Configuration File
-
-NetBox's configuration file contains all the important parameters which control how NetBox functions: database settings, security controls, user preferences, and so on. While the default configuration suffices out of the box for most use cases, there are a few [required parameters](./required-parameters.md) which **must** be defined during installation. 
-
-The configuration file is loaded from `$INSTALL_ROOT/netbox/netbox/configuration.py` by default. An example configuration is provided at `configuration_example.py`, which you may copy to use as your default config. Note that a configuration file must be defined; NetBox will not run without one.
-
-!!! info "Customizing the Configuration Module"
-    A custom configuration module may be specified by setting the `NETBOX_CONFIGURATION` environment variable. This must be a dotted path to the desired Python module. For example, a file named `my_config.py` in the same directory as `settings.py` would be referenced as `netbox.my_config`.
-
-    To keep things simple, the NetBox documentation refers to the configuration file simply as `configuration.py`.
-
-Some configuration parameters may alternatively be defined either in `configuration.py` or within the administrative section of the user interface. Settings which are "hard-coded" in the configuration file take precedence over those defined via the UI.
-
-## Dynamic Configuration Parameters
-
-Some configuration parameters are primarily controlled via NetBox's admin interface (under Admin > Extras > Configuration Revisions). These are noted where applicable in the documentation. These settings may also be overridden in `configuration.py` to prevent them from being modified via the UI. A complete list of supported parameters is provided below:
-
-* [`ALLOWED_URL_SCHEMES`](./security.md#allowed_url_schemes)
-* [`BANNER_BOTTOM`](./miscellaneous.md#banner_bottom)
-* [`BANNER_LOGIN`](./miscellaneous.md#banner_login)
-* [`BANNER_TOP`](./miscellaneous.md#banner_top)
-* [`CHANGELOG_RETENTION`](./miscellaneous.md#changelog_retention)
-* [`CUSTOM_VALIDATORS`](./data-validation.md#custom_validators)
-* [`DEFAULT_USER_PREFERENCES`](./default-values.md#default_user_preferences)
-* [`ENFORCE_GLOBAL_UNIQUE`](./miscellaneous.md#enforce_global_unique)
-* [`GRAPHQL_ENABLED`](./miscellaneous.md#graphql_enabled)
-* [`JOBRESULT_RETENTION`](./miscellaneous.md#jobresult_retention)
-* [`MAINTENANCE_MODE`](./miscellaneous.md#maintenance_mode)
-* [`MAPS_URL`](./miscellaneous.md#maps_url)
-* [`MAX_PAGE_SIZE`](./miscellaneous.md#max_page_size)
-* [`NAPALM_ARGS`](./napalm.md#napalm_args)
-* [`NAPALM_PASSWORD`](./napalm.md#napalm_password)
-* [`NAPALM_TIMEOUT`](./napalm.md#napalm_timeout)
-* [`NAPALM_USERNAME`](./napalm.md#napalm_username)
-* [`PAGINATE_COUNT`](./default-values.md#paginate_count)
-* [`POWERFEED_DEFAULT_AMPERAGE`](./default-values.md#powerfeed_default_amperage)
-* [`POWERFEED_DEFAULT_MAX_UTILIZATION`](./default-values.md#powerfeed_default_max_utilization)
-* [`POWERFEED_DEFAULT_VOLTAGE`](./default-values.md#powerfeed_default_voltage)
-* [`PREFER_IPV4`](./miscellaneous.md#prefer_ipv4)
-* [`RACK_ELEVATION_DEFAULT_UNIT_HEIGHT`](./default-values.md#rack_elevation_default_unit_height)
-* [`RACK_ELEVATION_DEFAULT_UNIT_WIDTH`](./default-values.md#rack_elevation_default_unit_width)
-
-## Modifying the Configuration
-
-The configuration file may be modified at any time. However, the WSGI service (e.g. Gunicorn) must be restarted before these changes will take effect:
-
-```no-highlight
-$ sudo systemctl restart netbox
-```
-
-Configuration parameters which are set via the admin UI (those listed under "dynamic settings") take effect immediately.

docs/configuration/mandatory-settings.md

@@ -0,0 +1,45 @@
+NetBox's local configuration is held in `netbox/netbox/configuration.py`. An example configuration is provided at `netbox/netbox/configuration.example.py`. You may copy or rename the example configuration and make changes as appropriate. NetBox will not run without a configuration file.
+
+## ALLOWED_HOSTS
+
+This is a list of valid fully-qualified domain names (FQDNs) that is used to reach the NetBox service. Usually this is the same as the hostname for the NetBox server, but can also be different (e.g. when using a reverse proxy serving the NetBox website under a different FQDN than the hostname of the NetBox server). NetBox will not permit access to the server via any other hostnames (or IPs). The value of this option is also used to set `CSRF_TRUSTED_ORIGINS`, which restricts `HTTP POST` to the same set of hosts (more about this [here](https://docs.djangoproject.com/en/1.9/ref/settings/#std:setting-CSRF_TRUSTED_ORIGINS)). Keep in mind that NetBox, by default, has `USE_X_FORWARDED_HOST = True` (in `netbox/netbox/settings.py`) which means that if you're using a reverse proxy, it's the FQDN used to reach that reverse proxy which needs to be in this list (more about this [here](https://docs.djangoproject.com/en/1.9/ref/settings/#allowed-hosts)).
+
+Example:
+
+```
+ALLOWED_HOSTS = ['netbox.example.com', '192.0.2.123']
+```
+
+---
+
+## DATABASE
+
+NetBox requires access to a PostgreSQL database service to store data. This service can run locally or on a remote system. The following parameters must be defined within the `DATABASE` dictionary:
+
+* NAME - Database name
+* USER - PostgreSQL username
+* PASSWORD - PostgreSQL password
+* HOST - Name or IP address of the database server (use `localhost` if running locally)
+* PORT - TCP port of the PostgreSQL service; leave blank for default port (5432)
+
+Example:
+
+```
+DATABASE = {
+    'NAME': 'netbox',               # Database name
+    'USER': 'netbox',               # PostgreSQL username
+    'PASSWORD': 'J5brHrAXFLQSif0K', # PostgreSQL password
+    'HOST': 'localhost',            # Database server
+    'PORT': '',                     # Database port (leave blank for default)
+}
+```
+
+---
+
+## SECRET_KEY
+
+This is a secret cryptographic key is used to improve the security of cookies and password resets. The key defined here should not be shared outside of the configuration file. `SECRET_KEY` can be changed at any time, however be aware that doing so will invalidate all existing sessions.
+
+Please note that this key is **not** used for hashing user passwords or for the encrypted storage of secret data in NetBox.
+
+`SECRET_KEY` should be at least 50 characters in length and contain a random mix of letters, digits, and symbols. The script located at `netbox/generate_secret_key.py` may be used to generate a suitable key.

docs/configuration/miscellaneous.md

@@ -1,159 +0,0 @@
-# Miscellaneous Parameters
-
-## ADMINS
-
-NetBox will email details about critical errors to the administrators listed here. This should be a list of (name, email) tuples. For example:
-
-```python
-ADMINS = [
-    ['Hank Hill', 'hhill@example.com'],
-    ['Dale Gribble', 'dgribble@example.com'],
-]
-```
-
----
-
-## BANNER_BOTTOM
-
-!!! tip "Dynamic Configuration Parameter"
-
-Sets content for the bottom banner in the user interface.
-
----
-
-## BANNER_LOGIN
-
-!!! tip "Dynamic Configuration Parameter"
-
-This defines custom content to be displayed on the login page above the login form. HTML is allowed.
-
----
-
-## BANNER_TOP
-
-!!! tip "Dynamic Configuration Parameter"
-
-Sets content for the top banner in the user interface.
-
-!!! tip
-    If you'd like the top and bottom banners to match, set the following:
-    
-    ```python
-    BANNER_TOP = 'Your banner text'
-    BANNER_BOTTOM = BANNER_TOP
-    ```
-
----
-
-## CHANGELOG_RETENTION
-
-!!! tip "Dynamic Configuration Parameter"
-
-Default: 90
-
-The number of days to retain logged changes (object creations, updates, and deletions). Set this to `0` to retain
-changes in the database indefinitely.
-
-!!! warning
-    If enabling indefinite changelog retention, it is recommended to periodically delete old entries. Otherwise, the database may eventually exceed capacity.
-
----
-
-## ENFORCE_GLOBAL_UNIQUE
-
-!!! tip "Dynamic Configuration Parameter"
-
-Default: False
-
-By default, NetBox will permit users to create duplicate prefixes and IP addresses in the global table (that is, those which are not assigned to any VRF). This behavior can be disabled by setting `ENFORCE_GLOBAL_UNIQUE` to True.
-
----
-
-## GRAPHQL_ENABLED
-
-!!! tip "Dynamic Configuration Parameter"
-
-Default: True
-
-Setting this to False will disable the GraphQL API.
-
----
-
-## JOBRESULT_RETENTION
-
-!!! tip "Dynamic Configuration Parameter"
-
-Default: 90
-
-The number of days to retain job results (scripts and reports). Set this to `0` to retain
-job results in the database indefinitely.
-
-!!! warning
-    If enabling indefinite job results retention, it is recommended to periodically delete old entries. Otherwise, the database may eventually exceed capacity.
-
----
-
-## MAINTENANCE_MODE
-
-!!! tip "Dynamic Configuration Parameter"
-
-Default: False
-
-Setting this to True will display a "maintenance mode" banner at the top of every page. Additionally, NetBox will no longer update a user's "last active" time upon login. This is to allow new logins when the database is in a read-only state. Recording of login times will resume when maintenance mode is disabled.
-
----
-
-## MAPS_URL
-
-!!! tip "Dynamic Configuration Parameter"
-
-Default: `https://maps.google.com/?q=` (Google Maps)
-
-This specifies the URL to use when presenting a map of a physical location by street address or GPS coordinates. The URL must accept either a free-form street address or a comma-separated pair of numeric coordinates appended to it.
-
----
-
-## MAX_PAGE_SIZE
-
-!!! tip "Dynamic Configuration Parameter"
-
-Default: 1000
-
-A web user or API consumer can request an arbitrary number of objects by appending the "limit" parameter to the URL (e.g. `?limit=1000`). This parameter defines the maximum acceptable limit. Setting this to `0` or `None` will allow a client to retrieve _all_ matching objects at once with no limit by specifying `?limit=0`.
-
----
-
-## METRICS_ENABLED
-
-Default: False
-
-Toggle the availability Prometheus-compatible metrics at `/metrics`. See the [Prometheus Metrics](../integrations/prometheus-metrics.md) documentation for more details.
-
----
-
-## PREFER_IPV4
-
-!!! tip "Dynamic Configuration Parameter"
-
-Default: False
-
-When determining the primary IP address for a device, IPv6 is preferred over IPv4 by default. Set this to True to prefer IPv4 instead.
-
----
-
-## RELEASE_CHECK_URL
-
-Default: None (disabled)
-
-This parameter defines the URL of the repository that will be checked for new NetBox releases. When a new release is detected, a message will be displayed to administrative users on the home page. This can be set to the official repository (`'https://api.github.com/repos/netbox-community/netbox/releases'`) or a custom fork. Set this to `None` to disable automatic update checks.
-
-!!! note
-    The URL provided **must** be compatible with the [GitHub REST API](https://docs.github.com/en/rest).
-
----
-
-## RQ_DEFAULT_TIMEOUT
-
-Default: `300`
-
-The maximum execution time of a background task (such as running a custom script), in seconds.

docs/configuration/napalm.md

@@ -1,51 +0,0 @@
-# NAPALM Parameters
-
-## NAPALM_USERNAME
-
-## NAPALM_PASSWORD
-
-!!! tip "Dynamic Configuration Parameter"
-
-NetBox will use these credentials when authenticating to remote devices via the supported [NAPALM integration](../integrations/napalm.md), if installed. Both parameters are optional.
-
-!!! note
-    If SSH public key authentication has been set up on the remote device(s) for the system account under which NetBox runs, these parameters are not needed.
-
----
-
-## NAPALM_ARGS
-
-!!! tip "Dynamic Configuration Parameter"
-
-A dictionary of optional arguments to pass to NAPALM when instantiating a network driver. See the NAPALM documentation for a [complete list of optional arguments](https://napalm.readthedocs.io/en/latest/support/#optional-arguments). An example:
-
-```python
-NAPALM_ARGS = {
-    'api_key': '472071a93b60a1bd1fafb401d9f8ef41',
-    'port': 2222,
-}
-```
-
-Some platforms (e.g. Cisco IOS) require an argument named `secret` to be passed in addition to the normal password. If desired, you can use the configured `NAPALM_PASSWORD` as the value for this argument:
-
-```python
-NAPALM_USERNAME = 'username'
-NAPALM_PASSWORD = 'MySecretPassword'
-NAPALM_ARGS = {
-    'secret': NAPALM_PASSWORD,
-    # Include any additional args here
-}
-```
-
----
-
-## NAPALM_TIMEOUT
-
-!!! tip "Dynamic Configuration Parameter"
-
-Default: 30 seconds
-
-The amount of time (in seconds) to wait for NAPALM to connect to a device.
-
----
-

docs/configuration/optional-settings.md

@@ -0,0 +1,231 @@
+The following are optional settings which may be declared in `netbox/netbox/configuration.py`.
+
+## ADMINS
+
+NetBox will email details about critical errors to the administrators listed here. This should be a list of (name, email) tuples. For example:
+
+```
+ADMINS = [
+    ['Hank Hill', 'hhill@example.com'],
+    ['Dale Gribble', 'dgribble@example.com'],
+]
+```
+
+---
+
+## BANNER_TOP
+
+## BANNER_BOTTOM
+
+Setting these variables will display content in a banner at the top and/or bottom of the page, respectively. HTML is allowed. To replicate the content of the top banner in the bottom banner, set:
+
+```
+BANNER_TOP = 'Your banner text'
+BANNER_BOTTOM = BANNER_TOP
+```
+
+---
+
+## BANNER_LOGIN
+
+The value of this variable will be displayed on the login page above the login form. HTML is allowed.
+
+---
+
+## BASE_PATH
+
+Default: None
+
+The base URL path to use when accessing NetBox. Do not include the scheme or domain name. For example, if installed at http://example.com/netbox/, set:
+
+```
+BASE_PATH = 'netbox/'
+```
+
+---
+
+## CORS_ORIGIN_ALLOW_ALL
+
+Default: False
+
+If True, cross-origin resource sharing (CORS) requests will be accepted from all origins. If False, a whitelist will be used (see below).
+
+---
+
+## CORS_ORIGIN_WHITELIST
+
+## CORS_ORIGIN_REGEX_WHITELIST
+
+These settings specify a list of origins that are authorized to make cross-site API requests. Use `CORS_ORIGIN_WHITELIST` to define a list of exact hostnames, or `CORS_ORIGIN_REGEX_WHITELIST` to define a set of regular expressions. (These settings have no effect if `CORS_ORIGIN_ALLOW_ALL` is True.)
+
+---
+
+## DEBUG
+
+Default: False
+
+This setting enables debugging. This should be done only during development or troubleshooting. Never enable debugging on a production system, as it can expose sensitive data to unauthenticated users.
+
+---
+
+## EMAIL
+
+In order to send email, NetBox needs an email server configured. The following items can be defined within the `EMAIL` setting:
+
+* SERVER - Host name or IP address of the email server (use `localhost` if running locally)
+* PORT - TCP port to use for the connection (default: 25)
+* USERNAME - Username with which to authenticate
+* PASSSWORD - Password with which to authenticate
+* TIMEOUT - Amount of time to wait for a connection (seconds)
+* FROM_EMAIL - Sender address for emails sent by NetBox
+
+---
+
+# ENFORCE_GLOBAL_UNIQUE
+
+Default: False
+
+Enforcement of unique IP space can be toggled on a per-VRF basis. To enforce unique IP space within the global table (all prefixes and IP addresses not assigned to a VRF), set `ENFORCE_GLOBAL_UNIQUE` to True.
+
+---
+
+## LOGGING
+
+By default, all messages of INFO severity or higher will be logged to the console. Additionally, if `DEBUG` is False and email access has been configured, ERROR and CRITICAL messages will be emailed to the users defined in `ADMINS`.
+
+The Django framework on which NetBox runs allows for the customization of logging, e.g. to write logs to file. Please consult the [Django logging documentation](https://docs.djangoproject.com/en/1.11/topics/logging/) for more information on configuring this setting. Below is an example which will write all INFO and higher messages to a file:
+
+```
+LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'handlers': {
+        'file': {
+            'level': 'INFO',
+            'class': 'logging.FileHandler',
+            'filename': '/var/log/netbox.log',
+        },
+    },
+    'loggers': {
+        'django': {
+            'handlers': ['file'],
+            'level': 'INFO',
+        },
+    },
+}
+```
+
+---
+
+## LOGIN_REQUIRED
+
+Default: False
+
+Setting this to True will permit only authenticated users to access any part of NetBox. By default, anonymous users are permitted to access most data in NetBox (excluding secrets) but not make any changes.
+
+---
+
+## MAINTENANCE_MODE
+
+Default: False
+
+Setting this to True will display a "maintenance mode" banner at the top of every page.
+
+---
+
+## MAX_PAGE_SIZE
+
+Default: 1000
+
+An API consumer can request an arbitrary number of objects by appending the "limit" parameter to the URL (e.g. `?limit=1000`). This setting defines the maximum limit. Setting it to `0` or `None` will allow an API consumer to request all objects by specifying `?limit=0`.
+
+---
+
+## MEDIA_ROOT
+
+Default: $BASE_DIR/netbox/media/
+
+The file path to the location where media files (such as image attachments) are stored. By default, this is the `netbox/media` directory within the base NetBox installation path.
+
+---
+
+## NAPALM_USERNAME
+
+## NAPALM_PASSWORD
+
+NetBox will use these credentials when authenticating to remote devices via the [NAPALM library](https://napalm-automation.net/), if installed. Both parameters are optional.
+
+Note: If SSH public key authentication has been set up for the system account under which NetBox runs, these parameters are not needed.
+
+---
+
+## NAPALM_ARGS
+
+A dictionary of optional arguments to pass to NAPALM when instantiating a network driver. See the NAPALM documentation for a [complete list of optional arguments](http://napalm.readthedocs.io/en/latest/support/#optional-arguments). An example:
+
+```
+NAPALM_ARGS = {
+    'api_key': '472071a93b60a1bd1fafb401d9f8ef41',
+    'port': 2222,
+}
+```
+
+Note: Some platforms (e.g. Cisco IOS) require an argument named `secret` to be passed in addition to the normal password. If desired, you can use the configured `NAPALM_PASSWORD` as the value for this argument:
+
+```
+NAPALM_USERNAME = 'username'
+NAPALM_PASSWORD = 'MySecretPassword'
+NAPALM_ARGS = {
+    'secret': NAPALM_PASSWORD,
+    # Include any additional args here
+}
+```
+
+---
+
+## NAPALM_TIMEOUT
+
+Default: 30 seconds
+
+The amount of time (in seconds) to wait for NAPALM to connect to a device.
+
+---
+
+## PAGINATE_COUNT
+
+Default: 50
+
+Determine how many objects to display per page within each list of objects.
+
+---
+
+## PREFER_IPV4
+
+Default: False
+
+When determining the primary IP address for a device, IPv6 is preferred over IPv4 by default. Set this to True to prefer IPv4 instead.
+
+---
+
+## TIME_ZONE
+
+Default: UTC
+
+The time zone NetBox will use when dealing with dates and times. It is recommended to use UTC time unless you have a specific need to use a local time zone. [List of available time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+
+---
+
+## Date and Time Formatting
+
+You may define custom formatting for date and times. For detailed instructions on writing format strings, please see [the Django documentation](https://docs.djangoproject.com/en/dev/ref/templates/builtins/#date).
+
+Defaults:
+
+```
+DATE_FORMAT = 'N j, Y'               # June 26, 2016
+SHORT_DATE_FORMAT = 'Y-m-d'          # 2016-06-27
+TIME_FORMAT = 'g:i a'                # 1:23 p.m.
+SHORT_TIME_FORMAT = 'H:i:s'          # 13:23:00
+DATETIME_FORMAT = 'N j, Y g:i a'     # June 26, 2016 1:23 p.m.
+SHORT_DATETIME_FORMAT = 'Y-m-d H:i'  # 2016-06-27 13:23
+```

docs/configuration/plugins.md

@@ -1,35 +0,0 @@
-# Plugin Parameters
-
-## PLUGINS
-
-Default: Empty
-
-A list of installed [NetBox plugins](../../plugins/) to enable. Plugins will not take effect unless they are listed here.
-
-!!! warning
-    Plugins extend NetBox by allowing external code to run with the same access and privileges as NetBox itself. Only install plugins from trusted sources. The NetBox maintainers make absolutely no guarantees about the integrity or security of your installation with plugins enabled.
-
----
-
-## PLUGINS_CONFIG
-
-Default: Empty
-
-This parameter holds configuration settings for individual NetBox plugins. It is defined as a dictionary, with each key using the name of an installed plugin. The specific parameters supported are unique to each plugin: Reference the plugin's documentation to determine the supported parameters. An example configuration is shown below:
-
-```python
-PLUGINS_CONFIG = {
-    'plugin1': {
-        'foo': 123,
-        'bar': True
-    },
-    'plugin2': {
-        'foo': 456,
-    },
-}
-```
-
-Note that a plugin must be listed in `PLUGINS` for its configuration to take effect.
-
----
-

docs/configuration/remote-authentication.md

@@ -1,110 +0,0 @@
-# Remote Authentication Settings
-
-The configuration parameters listed here control remote authentication for NetBox. Note that `REMOTE_AUTH_ENABLED` must be true in order for these settings to take effect.
-
----
-
-## REMOTE_AUTH_AUTO_CREATE_USER
-
-Default: `False`
-
-If true, NetBox will automatically create local accounts for users authenticated via a remote service. (Requires `REMOTE_AUTH_ENABLED`.)
-
----
-
-## REMOTE_AUTH_BACKEND
-
-Default: `'netbox.authentication.RemoteUserBackend'`
-
-This is the Python path to the custom [Django authentication backend](https://docs.djangoproject.com/en/stable/topics/auth/customizing/) to use for external user authentication. NetBox provides two built-in backends (listed below), though custom authentication backends may also be provided by other packages or plugins.
-
-* `netbox.authentication.RemoteUserBackend`
-* `netbox.authentication.LDAPBackend`
-
----
-
-## REMOTE_AUTH_DEFAULT_GROUPS
-
-Default: `[]` (Empty list)
-
-The list of groups to assign a new user account when created using remote authentication. (Requires `REMOTE_AUTH_ENABLED`.)
-
----
-
-## REMOTE_AUTH_DEFAULT_PERMISSIONS
-
-Default: `{}` (Empty dictionary)
-
-A mapping of permissions to assign a new user account when created using remote authentication. Each key in the dictionary should be set to a dictionary of the attributes to be applied to the permission, or `None` to allow all objects. (Requires `REMOTE_AUTH_ENABLED` as True and `REMOTE_AUTH_GROUP_SYNC_ENABLED` as False.)
-
----
-
-## REMOTE_AUTH_ENABLED
-
-Default: `False`
-
-NetBox can be configured to support remote user authentication by inferring user authentication from an HTTP header set by the HTTP reverse proxy (e.g. nginx or Apache). Set this to `True` to enable this functionality. (Local authentication will still take effect as a fallback.) (`REMOTE_AUTH_DEFAULT_GROUPS` will not function if `REMOTE_AUTH_ENABLED` is disabled)
-
----
-
-## REMOTE_AUTH_GROUP_HEADER
-
-Default: `'HTTP_REMOTE_USER_GROUP'`
-
-When remote user authentication is in use, this is the name of the HTTP header which informs NetBox of the currently authenticated user. For example, to use the request header `X-Remote-User-Groups` it needs to be set to `HTTP_X_REMOTE_USER_GROUPS`. (Requires `REMOTE_AUTH_ENABLED` and `REMOTE_AUTH_GROUP_SYNC_ENABLED` )
-
----
-
-## REMOTE_AUTH_GROUP_SEPARATOR
-
-Default: `|` (Pipe)
-
-The Seperator upon which `REMOTE_AUTH_GROUP_HEADER` gets split into individual Groups. This needs to be coordinated with your authentication Proxy. (Requires `REMOTE_AUTH_ENABLED` and `REMOTE_AUTH_GROUP_SYNC_ENABLED` )
-
----
-
-## REMOTE_AUTH_GROUP_SYNC_ENABLED
-
-Default: `False`
-
-NetBox can be configured to sync remote user groups by inferring user authentication from an HTTP header set by the HTTP reverse proxy (e.g. nginx or Apache). Set this to `True` to enable this functionality. (Local authentication will still take effect as a fallback.) (Requires `REMOTE_AUTH_ENABLED`.)
-
----
-
-## REMOTE_AUTH_HEADER
-
-Default: `'HTTP_REMOTE_USER'`
-
-When remote user authentication is in use, this is the name of the HTTP header which informs NetBox of the currently authenticated user. For example, to use the request header `X-Remote-User` it needs to be set to `HTTP_X_REMOTE_USER`. (Requires `REMOTE_AUTH_ENABLED`.)
-
----
-
-## REMOTE_AUTH_SUPERUSER_GROUPS
-
-Default: `[]` (Empty list)
-
-The list of groups that promote an remote User to Superuser on Login. If group isn't present on next Login, the Role gets revoked. (Requires `REMOTE_AUTH_ENABLED` and `REMOTE_AUTH_GROUP_SYNC_ENABLED` )
-
----
-
-## REMOTE_AUTH_SUPERUSERS
-
-Default: `[]` (Empty list)
-
-The list of users that get promoted to Superuser on Login. If user isn't present in list on next Login, the Role gets revoked. (Requires `REMOTE_AUTH_ENABLED` and `REMOTE_AUTH_GROUP_SYNC_ENABLED` )
-
----
-
-## REMOTE_AUTH_STAFF_GROUPS
-
-Default: `[]` (Empty list)
-
-The list of groups that promote an remote User to Staff on Login. If group isn't present on next Login, the Role gets revoked. (Requires `REMOTE_AUTH_ENABLED` and `REMOTE_AUTH_GROUP_SYNC_ENABLED` )
-
----
-
-## REMOTE_AUTH_STAFF_USERS
-
-Default: `[]` (Empty list)
-
-The list of users that get promoted to Staff on Login. If user isn't present in list on next Login, the Role gets revoked. (Requires `REMOTE_AUTH_ENABLED` and `REMOTE_AUTH_GROUP_SYNC_ENABLED` )

docs/configuration/required-parameters.md

@@ -1,148 +0,0 @@
-# Required Configuration Settings
-
-## ALLOWED_HOSTS
-
-This is a list of valid fully-qualified domain names (FQDNs) and/or IP addresses that can be used to reach the NetBox service. Usually this is the same as the hostname for the NetBox server, but can also be different; for example, when using a reverse proxy serving the NetBox website under a different FQDN than the hostname of the NetBox server. To help guard against [HTTP Host header attackes](https://docs.djangoproject.com/en/3.0/topics/security/#host-headers-virtual-hosting), NetBox will not permit access to the server via any other hostnames (or IPs).
-
-!!! note
-    This parameter must always be defined as a list or tuple, even if only a single value is provided.
-
-The value of this option is also used to set `CSRF_TRUSTED_ORIGINS`, which restricts POST requests to the same set of hosts (more about this [here](https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-CSRF_TRUSTED_ORIGINS)). Keep in mind that NetBox, by default, sets `USE_X_FORWARDED_HOST` to true, which means that if you're using a reverse proxy, it's the FQDN used to reach that reverse proxy which needs to be in this list (more about this [here](https://docs.djangoproject.com/en/stable/ref/settings/#allowed-hosts)).
-
-Example:
-
-```
-ALLOWED_HOSTS = ['netbox.example.com', '192.0.2.123']
-```
-
-If you are not yet sure what the domain name and/or IP address of the NetBox installation will be, and are comfortable accepting the risks in doing so, you can set this to a wildcard (asterisk) to allow all host values:
-
-```
-ALLOWED_HOSTS = ['*']
-```
-
----
-
-## DATABASE
-
-NetBox requires access to a PostgreSQL 10 or later database service to store data. This service can run locally on the NetBox server or on a remote system. The following parameters must be defined within the `DATABASE` dictionary:
-
-* `NAME` - Database name
-* `USER` - PostgreSQL username
-* `PASSWORD` - PostgreSQL password
-* `HOST` - Name or IP address of the database server (use `localhost` if running locally)
-* `PORT` - TCP port of the PostgreSQL service; leave blank for default port (TCP/5432)
-* `CONN_MAX_AGE` - Lifetime of a [persistent database connection](https://docs.djangoproject.com/en/stable/ref/databases/#persistent-connections), in seconds (300 is the default)
-
-Example:
-
-```python
-DATABASE = {
-    'NAME': 'netbox',               # Database name
-    'USER': 'netbox',               # PostgreSQL username
-    'PASSWORD': 'J5brHrAXFLQSif0K', # PostgreSQL password
-    'HOST': 'localhost',            # Database server
-    'PORT': '',                     # Database port (leave blank for default)
-    'CONN_MAX_AGE': 300,            # Max database connection age
-}
-```
-
-!!! note
-    NetBox supports all PostgreSQL database options supported by the underlying Django framework. For a complete list of available parameters, please see [the Django documentation](https://docs.djangoproject.com/en/stable/ref/settings/#databases).
-
----
-
-## REDIS
-
-[Redis](https://redis.io/) is an in-memory data store similar to memcached. While Redis has been an optional component of
-NetBox since the introduction of webhooks in version 2.4, it is required starting in 2.6 to support NetBox's caching
-functionality (as well as other planned features). In 2.7, the connection settings were broken down into two sections for
-task queuing and caching, allowing the user to connect to different Redis instances/databases per feature.
-
-Redis is configured using a configuration setting similar to `DATABASE` and these settings are the same for both of the `tasks` and `caching` subsections:
-
-* `HOST` - Name or IP address of the Redis server (use `localhost` if running locally)
-* `PORT` - TCP port of the Redis service; leave blank for default port (6379)
-* `PASSWORD` - Redis password (if set)
-* `DATABASE` - Numeric database ID
-* `SSL` - Use SSL connection to Redis
-* `INSECURE_SKIP_TLS_VERIFY` - Set to `True` to **disable** TLS certificate verification (not recommended)
-
-An example configuration is provided below:
-
-```python
-REDIS = {
-    'tasks': {
-        'HOST': 'redis.example.com',
-        'PORT': 1234,
-        'PASSWORD': 'foobar',
-        'DATABASE': 0,
-        'SSL': False,
-    },
-    'caching': {
-        'HOST': 'localhost',
-        'PORT': 6379,
-        'PASSWORD': '',
-        'DATABASE': 1,
-        'SSL': False,
-    }
-}
-```
-
-!!! note
-    If you are upgrading from a NetBox release older than v2.7.0, please note that the Redis connection configuration
-    settings have changed. Manual modification to bring the `REDIS` section inline with the above specification is
-    necessary
-
-!!! warning
-    It is highly recommended to keep the task and cache databases separate. Using the same database number on the
-    same Redis instance for both may result in queued background tasks being lost during cache flushing events.
-
-### Using Redis Sentinel
-
-If you are using [Redis Sentinel](https://redis.io/topics/sentinel) for high-availability purposes, there is minimal 
-configuration necessary to convert NetBox to recognize it. It requires the removal of the `HOST` and `PORT` keys from 
-above and the addition of three new keys.
-
-* `SENTINELS`: List of tuples or tuple of tuples with each inner tuple containing the name or IP address 
-of the Redis server and port for each sentinel instance to connect to
-* `SENTINEL_SERVICE`: Name of the master / service to connect to
-* `SENTINEL_TIMEOUT`: Connection timeout, in seconds
-
-Example:
-
-```python
-REDIS = {
-    'tasks': {
-        'SENTINELS': [('mysentinel.redis.example.com', 6379)],
-        'SENTINEL_SERVICE': 'netbox',
-        'SENTINEL_TIMEOUT': 10,
-        'PASSWORD': '',
-        'DATABASE': 0,
-        'SSL': False,
-    },
-    'caching': {
-        'SENTINELS': [
-            ('mysentinel.redis.example.com', 6379),
-            ('othersentinel.redis.example.com', 6379)
-        ],
-        'SENTINEL_SERVICE': 'netbox',
-        'PASSWORD': '',
-        'DATABASE': 1,
-        'SSL': False,
-    }
-}
-```
-
-!!! note
-    It is permissible to use Sentinel for only one database and not the other.
-
----
-
-## SECRET_KEY
-
-This is a secret, random string used to assist in the creation new cryptographic hashes for passwords and HTTP cookies. The key defined here should not be shared outside of the configuration file. `SECRET_KEY` can be changed at any time, however be aware that doing so will invalidate all existing sessions.
-
-Please note that this key is **not** used directly for hashing user passwords or for the encrypted storage of secret data in NetBox.
-
-`SECRET_KEY` should be at least 50 characters in length and contain a random mix of letters, digits, and symbols. The script located at `$INSTALL_ROOT/netbox/generate_secret_key.py` may be used to generate a suitable key.

docs/configuration/security.md

@@ -1,144 +0,0 @@
-# Security & Authentication Parameters
-
-## ALLOWED_URL_SCHEMES
-
-!!! tip "Dynamic Configuration Parameter"
-
-Default: `('file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp')`
-
-A list of permitted URL schemes referenced when rendering links within NetBox. Note that only the schemes specified in this list will be accepted: If adding your own, be sure to replicate all the default values as well (excluding those schemes which are not desirable).
-
----
-
-## AUTH_PASSWORD_VALIDATORS
-
-This parameter acts as a pass-through for configuring Django's built-in password validators for local user accounts. If configured, these will be applied whenever a user's password is updated to ensure that it meets minimum criteria such as length or complexity. An example is provided below. For more detail on the available options, please see [the Django documentation](https://docs.djangoproject.com/en/stable/topics/auth/passwords/#password-validation).
-
-```python
-AUTH_PASSWORD_VALIDATORS = [
-    {
-        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
-        'OPTIONS': {
-            'min_length': 10,
-        }
-    },
-]
-```
-
----
-
-## CORS_ORIGIN_ALLOW_ALL
-
-Default: False
-
-If True, cross-origin resource sharing (CORS) requests will be accepted from all origins. If False, a whitelist will be used (see below).
-
----
-
-## CORS_ORIGIN_WHITELIST
-
-## CORS_ORIGIN_REGEX_WHITELIST
-
-These settings specify a list of origins that are authorized to make cross-site API requests. Use
-`CORS_ORIGIN_WHITELIST` to define a list of exact hostnames, or `CORS_ORIGIN_REGEX_WHITELIST` to define a set of regular 
-expressions. (These settings have no effect if `CORS_ORIGIN_ALLOW_ALL` is True.) For example:
-
-```python
-CORS_ORIGIN_WHITELIST = [
-    'https://example.com',
-]
-```
-
----
-
-## CSRF_COOKIE_NAME
-
-Default: `csrftoken`
-
-The name of the cookie to use for the cross-site request forgery (CSRF) authentication token. See the [Django documentation](https://docs.djangoproject.com/en/stable/ref/settings/#csrf-cookie-name) for more detail.
-
----
-
----
-
-## CSRF_TRUSTED_ORIGINS
-
-Default: `[]`
-
-Defines a list of trusted origins for unsafe (e.g. `POST`) requests. This is a pass-through to Django's [`CSRF_TRUSTED_ORIGINS`](https://docs.djangoproject.com/en/4.0/ref/settings/#std:setting-CSRF_TRUSTED_ORIGINS) setting. Note that each host listed must specify a scheme (e.g. `http://` or `https://).
-
-```python
-CSRF_TRUSTED_ORIGINS = (
-    'http://netbox.local',
-    'https://netbox.local',
-)
-```
-
----
-
-## EXEMPT_VIEW_PERMISSIONS
-
-Default: Empty list
-
-A list of NetBox models to exempt from the enforcement of view permissions. Models listed here will be viewable by all users, both authenticated and anonymous.
-
-List models in the form `<app>.<model>`. For example:
-
-```python
-EXEMPT_VIEW_PERMISSIONS = [
-    'dcim.site',
-    'dcim.region',
-    'ipam.prefix',
-]
-```
-
-To exempt _all_ models from view permission enforcement, set the following. (Note that `EXEMPT_VIEW_PERMISSIONS` must be an iterable.)
-
-```python
-EXEMPT_VIEW_PERMISSIONS = ['*']
-```
-
-!!! note
-    Using a wildcard will not affect certain potentially sensitive models, such as user permissions. If there is a need to exempt these models, they must be specified individually.
-
----
-
-## LOGIN_PERSISTENCE
-
-Default: False
-
-If true, the lifetime of a user's authentication session will be automatically reset upon each valid request. For example, if [`LOGIN_TIMEOUT`](#login_timeout) is configured to 14 days (the default), and a user whose session is due to expire in five days makes a NetBox request (with a valid session cookie), the session's lifetime will be reset to 14 days.
-
-Note that enabling this setting causes NetBox to update a user's session in the database (or file, as configured per [`SESSION_FILE_PATH`](#session_file_path)) with each request, which may introduce significant overhead in very active environments. It also permits an active user to remain authenticated to NetBox indefinitely.
-
----
-
-## LOGIN_REQUIRED
-
-Default: False
-
-Setting this to True will permit only authenticated users to access any part of NetBox. By default, anonymous users are permitted to access most data in NetBox but not make any changes.
-
----
-
-## LOGIN_TIMEOUT
-
-Default: 1209600 seconds (14 days)
-
-The lifetime (in seconds) of the authentication cookie issued to a NetBox user upon login.
-
----
-
-## SESSION_COOKIE_NAME
-
-Default: `sessionid`
-
-The name used for the session cookie. See the [Django documentation](https://docs.djangoproject.com/en/stable/ref/settings/#session-cookie-name) for more detail.
-
----
-
-## SESSION_FILE_PATH
-
-Default: None
-
-HTTP session data is used to track authenticated users when they access NetBox. By default, NetBox stores session data in its PostgreSQL database. However, this inhibits authentication to a standby instance of NetBox without write access to the database. Alternatively, a local file path may be specified here and NetBox will store session data as files instead of using the database. Note that the NetBox system user must have read and write permissions to this path.

docs/configuration/system.md

@@ -1,178 +0,0 @@
-# System Parameters
-
-## BASE_PATH
-
-Default: None
-
-The base URL path to use when accessing NetBox. Do not include the scheme or domain name. For example, if installed at https://example.com/netbox/, set:
-
-```python
-BASE_PATH = 'netbox/'
-```
-
----
-
-## DOCS_ROOT
-
-Default: `$INSTALL_ROOT/docs/`
-
-The filesystem path to NetBox's documentation. This is used when presenting context-sensitive documentation in the web UI. By default, this will be the `docs/` directory within the root NetBox installation path. (Set this to `None` to disable the embedded documentation.)
-
----
-
-## EMAIL
-
-In order to send email, NetBox needs an email server configured. The following items can be defined within the `EMAIL` configuration parameter:
-
-* `SERVER` - Hostname or IP address of the email server (use `localhost` if running locally)
-* `PORT` - TCP port to use for the connection (default: `25`)
-* `USERNAME` - Username with which to authenticate
-* `PASSSWORD` - Password with which to authenticate
-* `USE_SSL` - Use SSL when connecting to the server (default: `False`)
-* `USE_TLS` - Use TLS when connecting to the server (default: `False`)
-* `SSL_CERTFILE` - Path to the PEM-formatted SSL certificate file (optional)
-* `SSL_KEYFILE` - Path to the PEM-formatted SSL private key file (optional)
-* `TIMEOUT` - Amount of time to wait for a connection, in seconds (default: `10`)
-* `FROM_EMAIL` - Sender address for emails sent by NetBox
-
-!!! note
-    The `USE_SSL` and `USE_TLS` parameters are mutually exclusive.
-
-Email is sent from NetBox only for critical events or if configured for [logging](#logging). If you would like to test the email server configuration, Django provides a convenient [send_mail()](https://docs.djangoproject.com/en/stable/topics/email/#send-mail) function accessible within the NetBox shell:
-
-```no-highlight
-# python ./manage.py nbshell
->>> from django.core.mail import send_mail
->>> send_mail(
-  'Test Email Subject',
-  'Test Email Body',
-  'noreply-netbox@example.com',
-  ['users@example.com'],
-  fail_silently=False
-)
-```
-
----
-
-## HTTP_PROXIES
-
-Default: None
-
-A dictionary of HTTP proxies to use for outbound requests originating from NetBox (e.g. when sending webhook requests). Proxies should be specified by schema (HTTP and HTTPS) as per the [Python requests library documentation](https://2.python-requests.org/en/master/user/advanced/). For example:
-
-```python
-HTTP_PROXIES = {
-    'http': 'http://10.10.1.10:3128',
-    'https': 'http://10.10.1.10:1080',
-}
-```
-
----
-
-## INTERNAL_IPS
-
-Default: `('127.0.0.1', '::1')`
-
-A list of IP addresses recognized as internal to the system, used to control the display of debugging output. For
-example, the debugging toolbar will be viewable only when a client is accessing NetBox from one of the listed IP
-addresses (and [`DEBUG`](#debug) is true).
-
----
-
-## JINJA2_FILTERS
-
-Default: `{}`
-
-A dictionary of custom jinja2 filters with the key being the filter name and the value being a callable. For more information see the [Jinja2 documentation](https://jinja.palletsprojects.com/en/3.1.x/api/#custom-filters). For example:
-
-```python
-def uppercase(x):
-    return str(x).upper()
-
-JINJA2_FILTERS = {
-    'uppercase': uppercase,
-}
-```
-
----
-
-## LOGGING
-
-By default, all messages of INFO severity or higher will be logged to the console. Additionally, if [`DEBUG`](#debug) is False and email access has been configured, ERROR and CRITICAL messages will be emailed to the users defined in [`ADMINS`](#admins).
-
-The Django framework on which NetBox runs allows for the customization of logging format and destination. Please consult the [Django logging documentation](https://docs.djangoproject.com/en/stable/topics/logging/) for more information on configuring this setting. Below is an example which will write all INFO and higher messages to a local file:
-
-```python
-LOGGING = {
-    'version': 1,
-    'disable_existing_loggers': False,
-    'handlers': {
-        'file': {
-            'level': 'INFO',
-            'class': 'logging.FileHandler',
-            'filename': '/var/log/netbox.log',
-        },
-    },
-    'loggers': {
-        'django': {
-            'handlers': ['file'],
-            'level': 'INFO',
-        },
-    },
-}
-```
-
-### Available Loggers
-
-* `netbox.<app>.<model>` - Generic form for model-specific log messages
-* `netbox.auth.*` - Authentication events
-* `netbox.api.views.*` - Views which handle business logic for the REST API
-* `netbox.reports.*` - Report execution (`module.name`)
-* `netbox.scripts.*` - Custom script execution (`module.name`)
-* `netbox.views.*` - Views which handle business logic for the web UI
-
----
-
-## MEDIA_ROOT
-
-Default: $INSTALL_ROOT/netbox/media/
-
-The file path to the location where media files (such as image attachments) are stored. By default, this is the `netbox/media/` directory within the base NetBox installation path.
-
----
-
-## REPORTS_ROOT
-
-Default: `$INSTALL_ROOT/netbox/reports/`
-
-The file path to the location where [custom reports](../customization/reports.md) will be kept. By default, this is the `netbox/reports/` directory within the base NetBox installation path.
-
----
-
-## SCRIPTS_ROOT
-
-Default: `$INSTALL_ROOT/netbox/scripts/`
-
-The file path to the location where [custom scripts](../customization/custom-scripts.md) will be kept. By default, this is the `netbox/scripts/` directory within the base NetBox installation path.
-
----
-
-## STORAGE_BACKEND
-
-Default: None (local storage)
-
-The backend storage engine for handling uploaded files (e.g. image attachments). NetBox supports integration with the [`django-storages`](https://django-storages.readthedocs.io/en/stable/) package, which provides backends for several popular file storage services. If not configured, local filesystem storage will be used.
-
-The configuration parameters for the specified storage backend are defined under the `STORAGE_CONFIG` setting.
-
----
-
-## STORAGE_CONFIG
-
-Default: Empty
-
-A dictionary of configuration parameters for the storage backend configured as `STORAGE_BACKEND`. The specific parameters to be used here are specific to each backend; see the [`django-storages` documentation](https://django-storages.readthedocs.io/en/stable/) for more detail.
-
-If `STORAGE_BACKEND` is not defined, this setting will be ignored.
-
----

docs/customization/custom-fields.md

@@ -1,108 +0,0 @@
-# Custom Fields
-
-Each model in NetBox is represented in the database as a discrete table, and each attribute of a model exists as a column within its table. For example, sites are stored in the `dcim_site` table, which has columns named `name`, `facility`, `physical_address`, and so on. As new attributes are added to objects throughout the development of NetBox, tables are expanded to include new rows.
-
-However, some users might want to store additional object attributes that are somewhat esoteric in nature, and that would not make sense to include in the core NetBox database schema. For instance, suppose your organization needs to associate each device with a ticket number correlating it with an internal support system record. This is certainly a legitimate use for NetBox, but it's not a common enough need to warrant including a field for _every_ NetBox installation. Instead, you can create a custom field to hold this data.
-
-Within the database, custom fields are stored as JSON data directly alongside each object. This alleviates the need for complex queries when retrieving objects.
-
-## Creating Custom Fields
-
-Custom fields may be created by navigating to Customization > Custom Fields. NetBox supports many types of custom field:
-
-* Text: Free-form text (intended for single-line use)
-* Long text: Free-form of any length; supports Markdown rendering
-* Integer: A whole number (positive or negative)
-* Boolean: True or false
-* Date: A date in ISO 8601 format (YYYY-MM-DD)
-* URL: This will be presented as a link in the web UI
-* JSON: Arbitrary data stored in JSON format
-* Selection: A selection of one of several pre-defined custom choices
-* Multiple selection: A selection field which supports the assignment of multiple values
-* Object: A single NetBox object of the type defined by `object_type`
-* Multiple object: One or more NetBox objects of the type defined by `object_type`
-
-Each custom field must have a name. This should be a simple database-friendly string (e.g. `tps_report`) and may contain only alphanumeric characters and underscores. You may also assign a corresponding human-friendly label (e.g. "TPS report"); the label will be displayed on web forms. A weight is also required: Higher-weight fields will be ordered lower within a form. (The default weight is 100.) If a description is provided, it will appear beneath the field in a form.
-
-Marking a field as required will force the user to provide a value for the field when creating a new object or when saving an existing object. A default value for the field may also be provided. Use "true" or "false" for boolean fields, or the exact value of a choice for selection fields.
-
-A custom field must be assigned to one or more object types, or models, in NetBox. Once created, custom fields will automatically appear as part of these models in the web UI and REST API. Note that not all models support custom fields.
-
-### Filtering
-
-The filter logic controls how values are matched when filtering objects by the custom field. Loose filtering (the default) matches on a partial value, whereas exact matching requires a complete match of the given string to a field's value. For example, exact filtering with the string "red" will only match the exact value "red", whereas loose filtering will match on the values "red", "red-orange", or "bored". Setting the filter logic to "disabled" disables filtering by the field entirely.
-
-### Grouping
-
-!!! note
-    This feature was introduced in NetBox v3.3.
-
-Related custom fields can be grouped together within the UI by assigning each the same group name. When at least one custom field for an object type has a group defined, it will appear under the group heading within the custom fields panel under the object view. All custom fields with the same group name will appear under that heading. (Note that the group names must match exactly, or each will appear as a separate heading.)
-
-This parameter has no effect on the API representation of custom field data.
-
-### Visibility
-
-!!! note
-    This feature was introduced in NetBox v3.3.
-
-When creating a custom field, there are three options for UI visibility. These control how and whether the custom field is displayed within the NetBox UI.
-
-* **Read/write** (default): The custom field is included when viewing and editing objects.
-* **Read-only**: The custom field is displayed when viewing an object, but it cannot be edited via the UI. (It will appear in the form as a read-only field.)
-* **Hidden**: The custom field will never be displayed within the UI. This option is recommended for fields which are not intended for use by human users.
-
-Note that this setting has no impact on the REST or GraphQL APIs: Custom field data will always be available via either API.
-
-### Validation
-
-NetBox supports limited custom validation for custom field values. Following are the types of validation enforced for each field type:
-
-* Text: Regular expression (optional)
-* Integer: Minimum and/or maximum value (optional)
-* Selection: Must exactly match one of the prescribed choices
-
-### Custom Selection Fields
-
-Each custom selection field must have at least two choices. These are specified as a comma-separated list. Choices appear in forms in the order they are listed. Note that choice values are saved exactly as they appear, so it's best to avoid superfluous punctuation or symbols where possible.
-
-If a default value is specified for a selection field, it must exactly match one of the provided choices. The value of a multiple selection field will always return a list, even if only one value is selected.
-
-### Custom Object Fields
-
-An object or multi-object custom field can be used to refer to a particular NetBox object or objects as the "value" for a custom field. These custom fields must define an `object_type`, which determines the type of object to which custom field instances point.
-
-## Custom Fields in Templates
-
-Several features within NetBox, such as export templates and webhooks, utilize Jinja2 templating. For convenience, objects which support custom field assignment expose custom field data through the `cf` property. This is a bit cleaner than accessing custom field data through the actual field (`custom_field_data`).
-
-For example, a custom field named `foo123` on the Site model is accessible on an instance as `{{ site.cf.foo123 }}`.
-
-## Custom Fields and the REST API
-
-When retrieving an object via the REST API, all of its custom data will be included within the `custom_fields` attribute. For example, below is the partial output of a site with two custom fields defined:
-
-```json
-{
-    "id": 123,
-    "url": "http://localhost:8000/api/dcim/sites/123/",
-    "name": "Raleigh 42",
-    ...
-    "custom_fields": {
-        "deployed": "2018-06-19",
-        "site_code": "US-NC-RAL42"
-    },
-    ...
-```
-
-To set or change these values, simply include nested JSON data. For example:
-
-```json
-{
-    "name": "New Site",
-    "slug": "new-site",
-    "custom_fields": {
-        "deployed": "2019-03-24"
-    }
-}
-```

docs/customization/custom-links.md

@@ -1,66 +0,0 @@
-# Custom Links
-
-Custom links allow users to display arbitrary hyperlinks to external content within NetBox object views. These are helpful for cross-referencing related records in systems outside NetBox. For example, you might create a custom link on the device view which links to the current device in a Network Monitoring System (NMS).
-
-Custom links are created by navigating to Customization > Custom Links. Each link is associated with a particular NetBox object type (site, device, prefix, etc.) and will be displayed on relevant views. Each link has display text and a URL, and data from the NetBox item being viewed can be included in the link using [Jinja2 template code](https://jinja2docs.readthedocs.io/en/stable/) through the variable `obj`, and custom fields through `obj.cf`.
-
-For example, you might define a link like this:
-
-* Text: `View NMS`
-* URL: `https://nms.example.com/nodes/?name={{ obj.name }}`
-
-When viewing a device named Router4, this link would render as:
-
-```no-highlight
-<a href="https://nms.example.com/nodes/?name=Router4">View NMS</a>
-```
-
-Custom links appear as buttons in the top right corner of the page. Numeric weighting can be used to influence the ordering of links, and each link can be enabled or disabled individually.
-
-!!! warning
-    Custom links rely on user-created code to generate arbitrary HTML output, which may be dangerous. Only grant permission to create or modify custom links to trusted users.
-
-## Context Data
-
-The following context data is available within the template when rendering a custom link's text or URL.
-
-| Variable  | Description                                                                                                       |
-|-----------|-------------------------------------------------------------------------------------------------------------------|
-| `object`  | The NetBox object being displayed                                                                                 |
-| `obj`     | Same as `object`; maintained for backward compatability until NetBox v3.5                                         |
-| `debug`   | A boolean indicating whether debugging is enabled                                                                 |
-| `request` | The current WSGI request                                                                                          |
-| `user`    | The current user (if authenticated)                                                                               |
-| `perms`   | The [permissions](https://docs.djangoproject.com/en/stable/topics/auth/default/#permissions) assigned to the user |
-
-While most of the context variables listed above will have consistent attributes, the object will be an instance of the specific object being viewed when the link is rendered. Different models have different fields and properties, so you may need to some research to determine the attributes available for use within your template for a specific object type.
-
-Checking the REST API representation of an object is generally a convenient way to determine what attributes are available. You can also reference the NetBox source code directly for a comprehensive list.
-
-## Conditional Rendering
-
-Only links which render with non-empty text are included on the page. You can employ conditional Jinja2 logic to control the conditions under which a link gets rendered.
-
-For example, if you only want to display a link for active devices, you could set the link text to
-
-```jinja2
-{% if obj.status == 'active' %}View NMS{% endif %}
-```
-
-The link will not appear when viewing a device with any status other than "active."
-
-As another example, if you wanted to show only devices belonging to a certain manufacturer, you could do something like this:
-
-```jinja2
-{% if obj.device_type.manufacturer.name == 'Cisco' %}View NMS{% endif %}
-```
-
-The link will only appear when viewing a device with a manufacturer name of "Cisco."
-
-## Link Groups
-
-Group names can be specified to organize links into groups. Links with the same group name will render as a dropdown menu beneath a single button bearing the name of the group.
-
-## Table Columns
-
-Custom links can also be included in object tables by selecting the desired links from the table configuration form. When displayed, each link will render as a hyperlink for its corresponding object. When exported (e.g. as CSV data), each link render only its URL.

docs/customization/custom-scripts.md

@@ -1,368 +0,0 @@
-# Custom Scripts
-
-Custom scripting was introduced to provide a way for users to execute custom logic from within the NetBox UI. Custom scripts enable the user to directly and conveniently manipulate NetBox data in a prescribed fashion. They can be used to accomplish myriad tasks, such as:
-
-* Automatically populate new devices and cables in preparation for a new site deployment
-* Create a range of new reserved prefixes or IP addresses
-* Fetch data from an external source and import it to NetBox
-
-Custom scripts are Python code and exist outside of the official NetBox code base, so they can be updated and changed without interfering with the core NetBox installation. And because they're completely custom, there is no inherent limitation on what a script can accomplish.
-
-## Writing Custom Scripts
-
-All custom scripts must inherit from the `extras.scripts.Script` base class. This class provides the functionality necessary to generate forms and log activity.
-
-```python
-from extras.scripts import Script
-
-class MyScript(Script):
-    ...
-```
-
-Scripts comprise two core components: a set of variables and a `run()` method. Variables allow your script to accept user input via the NetBox UI, but they are optional: If your script does not require any user input, there is no need to define any variables.
-
-The `run()` method is where your script's execution logic lives. (Note that your script can have as many methods as needed: this is merely the point of invocation for NetBox.)
-
-```python
-class MyScript(Script):
-    var1 = StringVar(...)
-    var2 = IntegerVar(...)
-    var3 = ObjectVar(...)
-
-    def run(self, data, commit):
-        ...
-```
-
-The `run()` method should accept two arguments:
-
-* `data` - A dictionary containing all of the variable data passed via the web form.
-* `commit` - A boolean indicating whether database changes will be committed.
-
-!!! note
-    The `commit` argument was introduced in NetBox v2.7.8. Backward compatibility is maintained for scripts which accept only the `data` argument, however beginning with v2.10 NetBox will require the `run()` method of every script to accept both arguments. (Either argument may still be ignored within the method.)
-
-Defining script variables is optional: You may create a script with only a `run()` method if no user input is needed.
-
-Any output generated by the script during its execution will be displayed under the "output" tab in the UI.
-
-By default, scripts within a module are ordered alphabetically in the scripts list page. To return scripts in a specific order, you can define the `script_order` variable at the end of your module. The `script_order` variable is a tuple which contains each Script class in the desired order. Any scripts that are omitted from this list will be listed last.
-
-```python
-from extras.scripts import Script
-
-class MyCustomScript(Script):
-    ...
-
-class AnotherCustomScript(Script):
-    ...
-
-script_order = (MyCustomScript, AnotherCustomScript)
-```
-
-## Module Attributes
-
-### `name`
-
-You can define `name` within a script module (the Python file which contains one or more scripts) to set the module name. If `name` is not defined, the module's file name will be used.
-
-## Script Attributes
-
-Script attributes are defined under a class named `Meta` within the script. These are optional, but encouraged.
-
-### `name`
-
-This is the human-friendly names of your script. If omitted, the class name will be used.
-
-### `description`
-
-A human-friendly description of what your script does.
-
-### `field_order`
-
-By default, script variables will be ordered in the form as they are defined in the script. `field_order` may be defined as an iterable of field names to determine the order in which variables are rendered. Any fields not included in this iterable be listed last.
-
-### `commit_default`
-
-The checkbox to commit database changes when executing a script is checked by default. Set `commit_default` to False under the script's Meta class to leave this option unchecked by default.
-
-```python
-commit_default = False
-```
-
-### `job_timeout`
-
-Set the maximum allowed runtime for the script. If not set, `RQ_DEFAULT_TIMEOUT` will be used.
-
-!!! info "This feature was introduced in v3.2.1"
-
-## Accessing Request Data
-
-Details of the current HTTP request (the one being made to execute the script) are available as the instance attribute `self.request`. This can be used to infer, for example, the user executing the script and the client IP address:
-
-```python
-username = self.request.user.username
-ip_address = self.request.META.get('HTTP_X_FORWARDED_FOR') or \
-    self.request.META.get('REMOTE_ADDR')
-self.log_info(f"Running as user {username} (IP: {ip_address})...")
-```
-
-For a complete list of available request parameters, please see the [Django documentation](https://docs.djangoproject.com/en/stable/ref/request-response/).
-
-## Reading Data from Files
-
-The Script class provides two convenience methods for reading data from files:
-
-* `load_yaml`
-* `load_json`
-
-These two methods will load data in YAML or JSON format, respectively, from files within the local path (i.e. `SCRIPTS_ROOT`).
-
-## Logging
-
-The Script object provides a set of convenient functions for recording messages at different severity levels:
-
-* `log_debug`
-* `log_success`
-* `log_info`
-* `log_warning`
-* `log_failure`
-
-Log messages are returned to the user upon execution of the script. Markdown rendering is supported for log messages.
-
-## Variable Reference
-
-### Default Options
-
-All custom script variables support the following default options:
-
-* `default` - The field's default value
-* `description` - A brief user-friendly description of the field
-* `label` - The field name to be displayed in the rendered form
-* `required` - Indicates whether the field is mandatory (all fields are required by default)
-* `widget` - The class of form widget to use (see the [Django documentation](https://docs.djangoproject.com/en/stable/ref/forms/widgets/))
-
-### StringVar
-
-Stores a string of characters (i.e. text). Options include:
-
-* `min_length` - Minimum number of characters
-* `max_length` - Maximum number of characters
-* `regex` - A regular expression against which the provided value must match
-
-Note that `min_length` and `max_length` can be set to the same number to effect a fixed-length field.
-
-### TextVar
-
-Arbitrary text of any length. Renders as a multi-line text input field.
-
-### IntegerVar
-
-Stores a numeric integer. Options include:
-
-* `min_value` - Minimum value
-* `max_value` - Maximum value
-
-### BooleanVar
-
-A true/false flag. This field has no options beyond the defaults listed above.
-
-### ChoiceVar
-
-A set of choices from which the user can select one.
-
-* `choices` - A list of `(value, label)` tuples representing the available choices. For example:
-
-```python
-CHOICES = (
-    ('n', 'North'),
-    ('s', 'South'),
-    ('e', 'East'),
-    ('w', 'West')
-)
-
-direction = ChoiceVar(choices=CHOICES)
-```
-
-In the example above, selecting the choice labeled "North" will submit the value `n`.
-
-### MultiChoiceVar
-
-Similar to `ChoiceVar`, but allows for the selection of multiple choices.
-
-### ObjectVar
-
-A particular object within NetBox. Each ObjectVar must specify a particular model, and allows the user to select one of the available instances. ObjectVar accepts several arguments, listed below.
-
-* `model` - The model class
-* `query_params` - A dictionary of query parameters to use when retrieving available options (optional)
-* `null_option` - A label representing a "null" or empty choice (optional)
-
-To limit the selections available within the list, additional query parameters can be passed as the `query_params` dictionary. For example, to show only devices with an "active" status:
-
-```python
-device = ObjectVar(
-    model=Device,
-    query_params={
-        'status': 'active'
-    }
-)
-```
-
-Multiple values can be specified by assigning a list to the dictionary key. It is also possible to reference the value of other fields in the form by prepending a dollar sign (`$`) to the variable's name.
-
-```python
-region = ObjectVar(
-    model=Region
-)
-site = ObjectVar(
-    model=Site,
-    query_params={
-        'region_id': '$region'
-    }
-)
-```
-
-### MultiObjectVar
-
-Similar to `ObjectVar`, but allows for the selection of multiple objects.
-
-### FileVar
-
-An uploaded file. Note that uploaded files are present in memory only for the duration of the script's execution: They will not be automatically saved for future use. The script is responsible for writing file contents to disk where necessary.
-
-### IPAddressVar
-
-An IPv4 or IPv6 address, without a mask. Returns a `netaddr.IPAddress` object.
-
-### IPAddressWithMaskVar
-
-An IPv4 or IPv6 address with a mask. Returns a `netaddr.IPNetwork` object which includes the mask.
-
-### IPNetworkVar
-
-An IPv4 or IPv6 network with a mask. Returns a `netaddr.IPNetwork` object. Two attributes are available to validate the provided mask:
-
-* `min_prefix_length` - Minimum length of the mask
-* `max_prefix_length` - Maximum length of the mask
-
-## Running Custom Scripts
-
-!!! note
-    To run a custom script, a user must be assigned the `extras.run_script` permission. This is achieved by assigning the user (or group) a permission on the Script object and specifying the `run` action in the admin UI as shown below.
-
-    ![Adding the run action to a permission](../media/admin_ui_run_permission.png)
-
-### Via the Web UI
-
-Custom scripts can be run via the web UI by navigating to the script, completing any required form data, and clicking the "run script" button.
-
-### Via the API
-
-To run a script via the REST API, issue a POST request to the script's endpoint specifying the form data and commitment. For example, to run a script named `example.MyReport`, we would make a request such as the following:
-
-```no-highlight
-curl -X POST \
--H "Authorization: Token $TOKEN" \
--H "Content-Type: application/json" \
--H "Accept: application/json; indent=4" \
-http://netbox/api/extras/scripts/example.MyReport/ \
---data '{"data": {"foo": "somevalue", "bar": 123}, "commit": true}'
-```
-
-### Via the CLI
-
-Scripts can be run on the CLI by invoking the management command:
-
-```
-python3 manage.py runscript [--commit] [--loglevel {debug,info,warning,error,critical}] [--data "<data>"] <module>.<script> 
-```
-
-The required ``<module>.<script>`` argument is the script to run where ``<module>`` is the name of the python file in the ``scripts`` directory without the ``.py`` extension and ``<script>`` is the name of the script class in the ``<module>`` to run.
-
-The optional ``--data "<data>"`` argument is the data to send to the script
-
-The optional ``--loglevel`` argument is the desired logging level to output to the console.
-
-The optional ``--commit`` argument will commit any changes in the script to the database.
-
-## Example
-
-Below is an example script that creates new objects for a planned site. The user is prompted for three variables:
-
-* The name of the new site
-* The device model (a filtered list of defined device types)
-* The number of access switches to create
-
-These variables are presented as a web form to be completed by the user. Once submitted, the script's `run()` method is called to create the appropriate objects.
-
-```python
-from django.utils.text import slugify
-
-from dcim.choices import DeviceStatusChoices, SiteStatusChoices
-from dcim.models import Device, DeviceRole, DeviceType, Manufacturer, Site
-from extras.scripts import *
-
-
-class NewBranchScript(Script):
-
-    class Meta:
-        name = "New Branch"
-        description = "Provision a new branch site"
-        field_order = ['site_name', 'switch_count', 'switch_model']
-
-    site_name = StringVar(
-        description="Name of the new site"
-    )
-    switch_count = IntegerVar(
-        description="Number of access switches to create"
-    )
-    manufacturer = ObjectVar(
-        model=Manufacturer,
-        required=False
-    )
-    switch_model = ObjectVar(
-        description="Access switch model",
-        model=DeviceType,
-        query_params={
-            'manufacturer_id': '$manufacturer'
-        }
-    )
-
-    def run(self, data, commit):
-
-        # Create the new site
-        site = Site(
-            name=data['site_name'],
-            slug=slugify(data['site_name']),
-            status=SiteStatusChoices.STATUS_PLANNED
-        )
-        site.save()
-        self.log_success(f"Created new site: {site}")
-
-        # Create access switches
-        switch_role = DeviceRole.objects.get(name='Access Switch')
-        for i in range(1, data['switch_count'] + 1):
-            switch = Device(
-                device_type=data['switch_model'],
-                name=f'{site.slug}-switch{i}',
-                site=site,
-                status=DeviceStatusChoices.STATUS_PLANNED,
-                device_role=switch_role
-            )
-            switch.save()
-            self.log_success(f"Created new switch: {switch}")
-
-        # Generate a CSV table of new devices
-        output = [
-            'name,make,model'
-        ]
-        for switch in Device.objects.filter(site=site):
-            attrs = [
-                switch.name,
-                switch.device_type.manufacturer.name,
-                switch.device_type.model
-            ]
-            output.append(','.join(attrs))
-
-        return '\n'.join(output)
-```

docs/customization/custom-validation.md

@@ -1,118 +0,0 @@
-# Custom Validation
-
-NetBox validates every object prior to it being written to the database to ensure data integrity. This validation includes things like checking for proper formatting and that references to related objects are valid. However, you may wish to supplement this validation with some rules of your own. For example, perhaps you require that every site's name conforms to a specific pattern.  This can be done using custom validation rules.
-
-## Custom Validation Rules
-
-Custom validation rules are expressed as a mapping of model attributes to a set of rules to which that attribute must conform. For example:
-
-```json
-{
-  "name": {
-    "min_length": 5,
-    "max_length": 30
-  }
-}
-```
-
-This defines a custom validator which checks that the length of the `name` attribute for an object is at least five characters long, and no longer than 30 characters. This validation is executed _after_ NetBox has performed its own internal validation.
-
-The `CustomValidator` class supports several validation types:
-
-* `min`: Minimum value
-* `max`: Maximum value
-* `min_length`: Minimum string length
-* `max_length`: Maximum string length
-* `regex`: Application of a [regular expression](https://en.wikipedia.org/wiki/Regular_expression)
-* `required`: A value must be specified
-* `prohibited`: A value must _not_ be specified
-
-The `min` and `max` types should be defined for numeric values, whereas `min_length`, `max_length`, and `regex` are suitable for character strings (text values). The `required` and `prohibited` validators may be used for any field, and should be passed a value of `True`.
-
-!!! warning
-    Bear in mind that these validators merely supplement NetBox's own validation: They will not override it. For example, if a certain model field is required by NetBox, setting a validator for it with `{'prohibited': True}` will not work.
-
-### Custom Validation Logic
-
-There may be instances where the provided validation types are insufficient. NetBox provides a `CustomValidator` class which can be extended to enforce arbitrary validation logic by overriding its `validate()` method, and calling `fail()` when an unsatisfactory condition is detected.
-
-```python
-from extras.validators import CustomValidator
-
-class MyValidator(CustomValidator):
-
-    def validate(self, instance):
-        if instance.status == 'active' and not instance.description:
-            self.fail("Active sites must have a description set!", field='status')
-```
-
-The `fail()` method may optionally specify a field with which to associate the supplied error message. If specified, the error message will appear to the user as associated with this field. If omitted, the error message will not be associated with any field.
-
-## Assigning Custom Validators
-
-Custom validators are associated with specific NetBox models under the [CUSTOM_VALIDATORS](../configuration/data-validation.md#custom_validators) configuration parameter. There are three manners by which custom validation rules can be defined:
-
-1. Plain JSON mapping (no custom logic)
-2. Dotted path to a custom validator class
-3. Direct reference to a custom validator class
-
-### Plain Data
-
-For cases where custom logic is not needed, it is sufficient to pass validation rules as plain JSON-compatible objects. This approach typically affords the most portability for your configuration. For instance:
-
-```python
-CUSTOM_VALIDATORS = {
-    "dcim.site": [
-        {
-            "name": {
-                "min_length": 5,
-                "max_length": 30,
-            }
-        }
-    ],
-    "dcim.device": [
-        {
-            "platform": {
-                "required": True,
-            }
-        }
-    ]
-}
-```
-
-### Dotted Path
-
-In instances where a custom validator class is needed, it can be referenced by its Python path (relative to NetBox's working directory):
-
-```python
-CUSTOM_VALIDATORS = {
-    'dcim.site': (
-        'my_validators.Validator1',
-        'my_validators.Validator2',
-    ),
-    'dcim.device': (
-        'my_validators.Validator3',
-    )
-}
-```
-
-### Direct Class Reference
-
-This approach requires each class being instantiated to be imported directly within the Python configuration file.
-
-```python
-from my_validators import Validator1, Validator2, Validator3
-
-CUSTOM_VALIDATORS = {
-    'dcim.site': (
-        Validator1(),
-        Validator2(),
-    ),
-    'dcim.device': (
-        Validator3(),
-    )
-}
-```
-
-!!! note
-    Even if defining only a single validator, it must be passed as an iterable.

docs/customization/export-templates.md

@@ -1,81 +0,0 @@
-# Export Templates
-
-NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Customization > Export Templates.
-
-Each export template is associated with a certain type of object. For instance, if you create an export template for VLANs, your custom template will appear under the "Export" button on the VLANs list. Each export template must have a name, and may optionally designate a specific export [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) and/or file extension.
-
-Export templates must be written in [Jinja2](https://jinja.palletsprojects.com/).
-
-!!! note
-    The name `table` is reserved for internal use.
-
-!!! warning
-    Export templates are rendered using user-submitted code, which may pose security risks under certain conditions. Only grant permission to create or modify export templates to trusted users.
-
-The list of objects returned from the database when rendering an export template is stored in the `queryset` variable, which you'll typically want to iterate through using a `for` loop. Object properties can be access by name. For example:
-
-```jinja2
-{% for rack in queryset %}
-Rack: {{ rack.name }}
-Site: {{ rack.site.name }}
-Height: {{ rack.u_height }}U
-{% endfor %}
-```
-
-To access custom fields of an object within a template, use the `cf` attribute. For example, `{{ obj.cf.color }}` will return the value (if any) for a custom field named `color` on `obj`.
-
-If you need to use the config context data in an export template, you'll should use the function `get_config_context` to get all the config context data. For example:
-```
-{% for server in queryset %}
-{% set data = server.get_config_context() %}
-{{ data.syslog }}
-{% endfor %}
-```
-
-The `as_attachment` attribute of an export template controls its behavior when rendered. If true, the rendered content will be returned to the user as a downloadable file. If false, it will be displayed within the browser. (This may be handy e.g. for generating HTML content.)
-
-A MIME type and file extension can optionally be defined for each export template. The default MIME type is `text/plain`.
-
-
-## REST API Integration
-
-When it is necessary to provide authentication credentials (such as when [`LOGIN_REQUIRED`](../configuration/security.md#login_required) has been enabled), it is recommended to render export templates via the REST API. This allows the client to specify an authentication token. To render an export template via the REST API, make a `GET` request to the model's list endpoint and append the `export` parameter specifying the export template name. For example:
-
-```
-GET /api/dcim/sites/?export=MyTemplateName
-```
-
-Note that the body of the response will contain only the rendered export template content, as opposed to a JSON object or list.
-
-## Example
-
-Here's an example device export template that will generate a simple Nagios configuration from a list of devices.
-
-```
-{% for device in queryset %}{% if device.status and device.primary_ip %}define host{
-        use                     generic-switch
-        host_name               {{ device.name }}
-        address                 {{ device.primary_ip.address.ip }}
-}
-{% endif %}{% endfor %}
-```
-
-The generated output will look something like this:
-
-```
-define host{
-        use                     generic-switch
-        host_name               switch1
-        address                 192.0.2.1
-}
-define host{
-        use                     generic-switch
-        host_name               switch2
-        address                 192.0.2.2
-}
-define host{
-        use                     generic-switch
-        host_name               switch3
-        address                 192.0.2.3
-}
-```

docs/data-model/circuits.md

@@ -0,0 +1,33 @@
+The circuits component of NetBox deals with the management of long-haul Internet and private transit links and providers.
+
+# Providers
+
+A provider is any entity which provides some form of connectivity. While this obviously includes carriers which offer Internet and private transit service, it might also include Internet exchange (IX) points and even organizations with whom you peer directly.
+
+Each provider may be assigned an autonomous system number (ASN), an account number, and contact information.
+
+---
+
+# Circuits
+
+A circuit represents a single physical data link connecting two endpoints. Each circuit belongs to a provider and must be assigned a circuit ID which is unique to that provider.
+
+### Circuit Types
+
+Circuits are classified by type. For example, you might define circuit types for:
+
+* Internet transit
+* Out-of-band connectivity
+* Peering
+* Private backhaul
+
+Circuit types are fully customizable.
+
+### Circuit Terminations
+
+A circuit may have one or two terminations, annotated as the "A" and "Z" sides of the circuit. A single-termination circuit can be used when you don't know (or care) about the far end of a circuit (for example, an Internet access circuit which connects to a transit provider). A dual-termination circuit is useful for tracking circuits which connect two sites.
+
+Each circuit termination is tied to a site, and optionally to a specific device and interface within that site. Each termination can be assigned a separate downstream and upstream speed independent from one another. Fields are also available to track cross-connect and patch panel details.
+
+!!! note
+    A circuit represents a physical link, and cannot have more than two endpoints. When modeling a multi-point topology, each leg of the topology must be defined as a discrete circuit.

docs/data-model/dcim.md

@@ -0,0 +1,114 @@
+Data center infrastructure management (DCIM) entails all physical assets: sites, racks, devices, cabling, etc.
+
+# Sites
+
+How you choose to use sites will depend on the nature of your organization, but typically a site will equate to a building or campus. For example, a chain of banks might create a site to represent each of its branches, a site for its corporate headquarters, and two additional sites for its presence in two colocation facilities.
+
+Sites can be assigned an optional facility ID to identify the actual facility housing colocated equipment, and an Autonomous System (AS) number.
+
+### Regions
+
+Sites can be arranged geographically using regions. A region might represent a continent, country, city, campus, or other area depending on your use case. Regions can be nested recursively to construct a hierarchy. For example, you might define several country regions, and within each of those several state or city regions to which sites are assigned.
+
+---
+
+# Racks
+
+The rack model represents a physical two- or four-post equipment rack in which equipment is mounted. Each rack is assigned to a site. Rack height is measured in *rack units* (U); racks are commonly between 42U and 48U, but NetBox allows you to define racks of arbitrary height. Each rack has two faces (front and rear) on which devices can be mounted.
+
+Each rack is assigned a name and (optionally) a separate facility ID. This is helpful when leasing space in a data center your organization does not own: The facility will often assign a seemingly arbitrary ID to a rack (for example, "M204.313") whereas internally you refer to is simply as "R113." The facility ID can alternatively be used to store a rack's serial number.
+
+The available rack types include 2- and 4-post frames, 4-post cabinet, and wall-mounted frame and cabinet. Rail-to-rail width may be 19 or 23 inches.
+
+### Rack Groups
+
+Racks can be arranged into groups. As with sites, how you choose to designate rack groups will depend on the nature of your organization. For example, if each site represents a campus, each group might represent a building within a campus. If each site represents a building, each rack group might equate to a floor or room.
+
+Each group is assigned to a parent site for easy navigation. Hierarchical recursion of rack groups is not supported.
+
+### Rack Roles
+
+Each rack can optionally be assigned a functional role. For example, you might designate a rack for compute or storage resources, or to house colocated customer devices. Rack roles are fully customizable.
+
+### Rack Space Reservations
+
+Users can reserve units within a rack for future use. Multiple non-contiguous rack units can be associated with a single reservation (but reservations cannot span multiple racks).
+
+---
+
+# Device Types
+
+A device type represents a particular hardware model that exists in the real world. Device types describe the physical attributes of a device (rack height and depth), its class (e.g. console server, PDU, etc.), and its individual components (console, power, and data).
+
+Device types are instantiated as devices installed within racks. For example, you might define a device type to represent a Juniper EX4300-48T network switch with 48 Ethernet interfaces. You can then create multiple devices of this type named "switch1," "switch2," and so on. Each device will inherit the components (such as interfaces) of its device type.
+
+### Manufacturers
+
+Each device type belongs to one manufacturer; e.g. Cisco, Opengear, or APC. The model number of a device type must be unique to its manufacturer.
+
+### Component Templates
+
+Each device type is assigned a number of component templates which define the physical interfaces a device has. These are:
+
+* Console ports
+* Console server ports
+* Power ports
+* Power outlets
+* Interfaces
+* Device bays
+
+Whenever a new device is created, it is automatically assigned components per the templates assigned to its device type. For example, a Juniper EX4300-48T device type might have the following component templates:
+
+* One template for a console port ("Console")
+* Two templates for power ports ("PSU0" and "PSU1")
+* 48 templates for 1GE interfaces ("ge-0/0/0" through "ge-0/0/47")
+* Four templates for 10GE interfaces ("xe-0/2/0" through "xe-0/2/3")
+
+Once component templates have been created, every new device that you create as an instance of this type will automatically be assigned each of the components listed above.
+
+!!! note
+    Assignment of components from templates occurs only at the time of device creation. If you modify the templates of a device type, it will not affect devices which have already been created. However, you always have the option of adding, modifying, or deleting components of existing devices individually.
+
+---
+
+# Devices
+
+Every piece of hardware which is installed within a rack exists in NetBox as a device. Devices are measured in rack units (U) and depth. 0U devices which can be installed in a rack but don't consume vertical rack space (such as a vertically-mounted power distribution unit) can also be defined.
+
+When assigning a multi-U device to a rack, it is considered to be mounted in the lowest-numbered rack unit which it occupies. For example, a 3U device which occupies U8 through U10 shows as being mounted in U8. This logic applies to racks with both ascending and descending unit numbering.
+
+A device is said to be "full depth" if its installation on one rack face prevents the installation of any other device on the opposite face within the same rack unit(s). This could be either because the device is physically too deep to allow a device behind it, or because the installation of an opposing device would impede air flow.
+
+### Roles
+
+NetBox allows for the definition of arbitrary device roles by which devices can be organized. For example, you might create roles for core switches, distribution switches, and access switches. In the interest of simplicity, a device can belong to only one role.
+
+### Platforms
+
+A device's platform is used to denote the type of software running on it. This can be helpful when it is necessary to distinguish between, for instance, different feature sets. Note that two devices of same type may be assigned different platforms: for example, one Juniper MX240 running Junos 14 and another running Junos 15.
+
+The assignment of platforms to devices is an optional feature, and may be disregarded if not desired.
+
+### Inventory Items
+
+Inventory items represent hardware components installed within a device, such as a power supply or CPU. Currently, these are used merely for inventory tracking, although future development might see their functionality expand. Each item can optionally be assigned a manufacturer.
+
+!!! note
+    Prior to version 2.0, inventory items were called modules.
+
+### Components
+
+There are six types of device components which comprise all of the interconnection logic with NetBox:
+
+* Console ports
+* Console server ports
+* Power ports
+* Power outlets
+* Interfaces
+* Device bays
+
+Console ports connect only to console server ports, and power ports connect only to power outlets. Interfaces connect to one another in a symmetric manner: If interface A connects to interface B, interface B therefore connects to interface A. (The relationship between two interfaces is actually represented in the database by an InterfaceConnection object, but this is transparent to the user.) Each type of connection can be classified as either *planned* or *connected*. This allows for easily denoting connections which have not yet been installed.
+
+Each interface is a assigned a form factor denoting its physical properties. Two special form factors exist: the "virtual" form factor can be used to designate logical interfaces (such as SVIs), and the "LAG" form factor can be used to desinate link aggregation groups to which physical interfaces can be assigned. Each interface can also be designated as management-only (for out-of-band management) and assigned a short description.
+
+Device bays represent the ability of a device to house child devices. For example, you might install four blade servers into a 2U chassis. The chassis would appear in the rack elevation as a 2U device with four device bays. Each server within it would be defined as a 0U device installed in one of the device bays. Child devices do not appear on rack elevations, but they are included in the "Non-Racked Devices" list within the rack view.

docs/data-model/extras.md

@@ -0,0 +1,132 @@
+This section entails features of NetBox which are not crucial to its primary functions, but provide additional value.
+
+# Custom Fields
+
+Each object in NetBox is represented in the database as a discrete table, and each attribute of an object exists as a column within its table. For example, sites are stored in the `dcim_site` table, which has columns named `name`, `facility`, `physical_address`, and so on. As new attributes are added to objects throughout the development of NetBox, tables are expanded to include new rows.
+
+However, some users might want to associate with objects attributes that are somewhat esoteric in nature, and that would not make sense to include in the core NetBox database schema. For instance, suppose your organization needs to associate each device with a ticket number pointing to the support ticket that was opened to have it installed. This is certainly a legitimate use for NetBox, but it's perhaps not a common enough need to warrant expanding the internal data schema. Instead, you can create a custom field to hold this data.
+
+Custom fields must be created through the admin UI under Extras > Custom Fields. To create a new custom field, select the object(s) to which you want it to apply, and the type of field it will be. NetBox supports six field types:
+
+* Free-form text (up to 255 characters)
+* Integer
+* Boolean (true/false)
+* Date
+* URL
+* Selection
+
+Assign the field a name. This should be a simple database-friendly string, e.g. `tps_report`. You may optionally assign the field a human-friendly label (e.g. "TPS report") as well; the label will be displayed on forms. If a description is provided, it will appear beneath the field in a form.
+
+Marking the field as required will require the user to provide a value for the field when creating a new object or when saving an existing object. A default value for the field may also be provided. Use "true" or "false" for boolean fields. (The default value has no effect for selection fields.)
+
+When creating a selection field, you should create at least two choices. These choices will be arranged first by weight, with lower weights appearing higher in the list, and then alphabetically.
+
+## Using Custom Fields
+
+When a single object is edited, the form will include any custom fields which have been defined for the object type. These fields are included in the "Custom Fields" panel. On the backend, each custom field value is saved separately from the core object as an independent database call, so it's best to avoid adding too many custom fields per object.
+
+When editing multiple objects, custom field values are saved in bulk. There is no significant difference in overhead when saving a custom field value for 100 objects versus one object. However, the bulk operation must be performed separately for each custom field.
+
+# Export Templates
+
+NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Extras > Export Templates under the admin interface.
+
+Each export template is associated with a certain type of object. For instance, if you create an export template for VLANs, your custom template will appear under the "Export" button on the VLANs list.
+
+Export templates are written in [Django's template language](https://docs.djangoproject.com/en/1.9/ref/templates/language/), which is very similar to Jinja2. The list of objects returned from the database is stored in the `queryset` variable, which you'll typically want to iterate through using a `for` loop. Object properties can be access by name. For example:
+
+```
+{% for rack in queryset %}
+Rack: {{ rack.name }}
+Site: {{ rack.site.name }}
+Height: {{ rack.u_height }}U
+{% endfor %}
+```
+
+To access custom fields of an object within a template, use the `cf` attribute. For example, `{{ obj.cf.color }}` will return the value (if any) for a custom field named `color` on `obj`.
+
+A MIME type and file extension can optionally be defined for each export template. The default MIME type is `text/plain`.
+
+## Example
+
+Here's an example device export template that will generate a simple Nagios configuration from a list of devices.
+
+```
+{% for device in queryset %}{% if device.status and device.primary_ip %}define host{
+        use                     generic-switch
+        host_name               {{ device.name }}
+        address                 {{ device.primary_ip.address.ip }}
+}
+{% endif %}{% endfor %}
+```
+
+The generated output will look something like this:
+
+```
+define host{
+        use                     generic-switch
+        host_name               switch1
+        address                 192.0.2.1
+}
+define host{
+        use                     generic-switch
+        host_name               switch2
+        address                 192.0.2.2
+}
+define host{
+        use                     generic-switch
+        host_name               switch3
+        address                 192.0.2.3
+}
+```
+
+# Graphs
+
+NetBox does not have the ability to generate graphs natively, but this feature allows you to embed contextual graphs from an external resources (such as a monitoring system) inside the site, provider, and interface views. Each embedded graph must be defined with the following parameters:
+
+* **Type:** Site, provider, or interface. This determines in which view the graph will be displayed.
+* **Weight:** Determines the order in which graphs are displayed (lower weights are displayed first). Graphs with equal weights will be ordered alphabetically by name.
+* **Name:** The title to display above the graph.
+* **Source URL:** The source of the image to be embedded. The associated object will be available as a template variable named `obj`.
+* **Link URL (optional):** A URL to which the graph will be linked. The associated object will be available as a template variable named `obj`.
+
+## Examples
+
+You only need to define one graph object for each graph you want to include when viewing an object. For example, if you want to include a graph of traffic through an interface over the past five minutes, your graph source might looks like this:
+
+```
+https://my.nms.local/graphs/?node={{ obj.device.name }}&interface={{ obj.name }}&duration=5m
+```
+
+You can define several graphs to provide multiple contexts when viewing an object. For example:
+
+```
+https://my.nms.local/graphs/?type=throughput&node={{ obj.device.name }}&interface={{ obj.name }}&duration=60m
+https://my.nms.local/graphs/?type=throughput&node={{ obj.device.name }}&interface={{ obj.name }}&duration=24h
+https://my.nms.local/graphs/?type=errors&node={{ obj.device.name }}&interface={{ obj.name }}&duration=60m
+```
+
+# Topology Maps
+
+NetBox can generate simple topology maps from the physical network connections recorded in its database. First, you'll need to create a topology map definition under the admin UI at Extras > Topology Maps.
+
+Each topology map is associated with a site. A site can have multiple topology maps, which might each illustrate a different aspect of its infrastructure (for example, production versus backend infrastructure).
+
+To define the scope of a topology map, decide which devices you want to include. The map will only include interface connections with both points terminated on an included device. Specify the devices to include in the **device patterns** field by entering a list of [regular expressions](https://en.wikipedia.org/wiki/Regular_expression) matching device names. For example, if you wanted to include "mgmt-switch1" through "mgmt-switch99", you might use the regex `mgmt-switch\d+`.
+
+Each line of the **device patterns** field represents a hierarchical layer within the topology map. For example, you might map a traditional network with core, distribution, and access tiers like this:
+
+```
+core-switch-[abcd]
+dist-switch\d
+access-switch\d+;oob-switch\d+
+```
+
+Note that you can combine multiple regexes onto one line using semicolons. The order in which regexes are listed on a line is significant: devices matching the first regex will be rendered first, and subsequent groups will be rendered to the right of those.
+
+# Image Attachments
+
+Certain objects within NetBox (namely sites, racks, and devices) can have photos or other images attached to them. (Note that _only_ image files are supported.) Each attachment may optionally be assigned a name; if omitted, the attachment will be represented by its file name.
+
+!!! note
+    If you experience a server error while attempting to upload an image attachment, verify that the system user NetBox runs as has write permission to the media root directory (`netbox/media/`).

docs/data-model/ipam.md

@@ -0,0 +1,99 @@
+IP address management (IPAM) entails the allocation of IP networks, addresses, and related numeric resources.
+
+# VRFs
+
+A VRF object in NetBox represents a virtual routing and forwarding (VRF) domain within a network. Each VRF is essentially a separate routing table: the same IP prefix or address can exist in multiple VRFs. VRFs are commonly used to isolate customers or organizations from one another within a network.
+
+Each VRF is assigned a name and a unique route distinguisher (RD). VRFs are an optional feature of NetBox: Any IP prefix or address not assigned to a VRF is said to belong to the "global" table.
+
+!!! note
+    By default, NetBox allows for overlapping IP space both in the global table and within each VRF. Unique space enforcement can be toggled per-VRF as well as in the global table using the `ENFORCE_GLOBAL_UNIQUE` configuration setting.
+
+---
+
+# Aggregates
+
+IP address space is organized as a hierarchy, with more-specific (smaller) prefixes arranged as child nodes under less-specific (larger) prefixes. For example:
+
+* 10.0.0.0/8
+    * 10.1.0.0/16
+        * 10.1.2.0/24
+
+The root of the IPv4 hierarchy is 0.0.0.0/0, which encompasses all possible IPv4 addresses (and similarly, ::/0 for IPv6). However, even the largest organizations use only a small fraction of the global address space. Therefore, it makes sense to track in NetBox only the address space which is of interest to your organization.
+
+Aggregates serve as arbitrary top-level nodes in the IP space hierarchy. They allow you to easily construct your IP scheme without any clutter of unused address space. For instance, most organizations utilize some portion of the private IPv4 space set aside in RFC 1918. So, you might define three aggregates for this space:
+
+* 10.0.0.0/8
+* 172.16.0.0/12
+* 192.168.0.0/16
+
+Additionally, you might define an aggregate for each large swath of public IPv4 space your organization uses. You'd also create aggregates for both globally routable and unique local IPv6 space. (Most organizations will not have a need to track IPv6 link local space.)
+
+Prefixes you create in NetBox (discussed below) will be automatically organized under their respective aggregates. Any space within an aggregate which is not covered by an existing prefix will be annotated as available for allocation. Total utilization for each aggregate is displayed in the aggregates list.
+
+Aggregates cannot overlap with one another; they can only exist in parallel. For instance, you cannot define both 10.0.0.0/8 and 10.16.0.0/16 as aggregates, because they overlap. 10.16.0.0/16 in this example would be created as a prefix and automatically grouped under 10.0.0.0/8.
+
+### RIRs
+
+Regional Internet Registries (RIRs) are responsible for the allocation of global address space. The five RIRs are ARIN, RIPE, APNIC, LACNIC, and AFRINIC. However, some address space has been set aside for private or internal use only, such as defined in RFCs 1918 and 6598. NetBox considers these RFCs as a sort of RIR as well; that is, an authority which "owns" certain address space.
+
+Each aggregate must be assigned to one RIR. You are free to define whichever RIRs you choose (or create your own). Each RIR can be annotated as representing only private space.
+
+---
+
+# Prefixes
+
+A prefix is an IPv4 or IPv6 network and mask expressed in CIDR notation (e.g. 192.0.2.0/24). A prefix entails only the "network portion" of an IP address; all bits in the address not covered by the mask must be zero.
+
+Each prefix may be assigned to one VRF; prefixes not assigned to a VRF are assigned to the "global" table. Prefixes are also organized under their respective aggregates, irrespective of VRF assignment.
+
+A prefix may optionally be assigned to one VLAN; a VLAN may have multiple prefixes assigned to it. Each prefix may also be assigned a short description.
+
+### Statuses
+
+Each prefix is assigned an operational status. This is one of the following:
+
+* Container - A summary of child prefixes
+* Active - Provisioned and in use
+* Reserved - Designated for future use
+* Deprecated - No longer in use
+
+### Roles
+
+Whereas a status describes a prefix's operational state, a role describes its function. For example, roles might include:
+
+* Access segment
+* Infrastructure
+* NAT
+* Lab
+* Out-of-band
+
+Role assignment is optional and roles are fully customizable.
+
+---
+
+# IP Addresses
+
+An IP address comprises a single address (either IPv4 or IPv6) and its subnet mask. Its mask should match exactly how the IP address is configured on an interface in the real world.
+
+Like prefixes, an IP address can optionally be assigned to a VRF (or it will appear in the "global" table). IP addresses are automatically organized under parent prefixes within their respective VRFs. Each IP address can also be assigned a short description.
+
+An IP address can be assigned to a device's interface; an interface may have multiple IP addresses assigned to it. Further, each device may have one of its interface IPs designated as its primary IP address (for both IPv4 and IPv6).
+
+One IP address can be designated as the network address translation (NAT) IP address for exactly one other IP address. This is useful primarily to denote the public address for a private internal IP. Tracking one-to-many NAT (or PAT) assignments is not supported.
+
+---
+
+# VLANs
+
+A VLAN represents an isolated layer two domain, identified by a name and a numeric ID (1-4094) as defined in [IEEE 802.1Q](https://en.wikipedia.org/wiki/IEEE_802.1Q). Each VLAN may be assigned to a site and/or VLAN group. Like prefixes, each VLAN is assigned an operational status and (optionally) a functional role, and may include a short description.
+
+### VLAN Groups
+
+VLAN groups can be employed for administrative organization within NetBox. Each VLAN within a group must have a unique ID and name. VLANs which are not assigned to a group may have overlapping names and IDs, including within a site.
+
+---
+
+# Services
+
+A service represents a TCP or UDP service available on a device or virtual machine. Each service must be defined with a name, protocol, and port number; for example, "SSH (TCP/22)." A service may optionally be bound to one or more specific IP addresses belonging to its parent. (If no IP addresses are bound, the service is assumed to be reachable via any assigned IP address.)

docs/data-model/secrets.md

@@ -0,0 +1,43 @@
+"Secrets" are small amounts of data that must be kept confidential; for example, passwords and SNMP community strings. NetBox provides encrypted storage of secret data.
+
+# Secrets
+
+A secret represents a single credential or other string which must be stored securely. Each secret is assigned to a device within NetBox. The plaintext value of a secret is encrypted to a ciphertext immediately prior to storage within the database using a 256-bit AES master key. A SHA256 hash of the plaintext is also stored along with each ciphertext to validate the decrypted plaintext.
+
+Each secret can also store an optional name parameter, which is not encrypted. This may be useful for storing user names.
+
+### Roles
+
+Each secret is assigned a functional role which indicates what it is used for. Typical roles might include:
+
+* Login credentials
+* SNMP community strings
+* RADIUS/TACACS+ keys
+* IKE key strings
+* Routing protocol shared secrets
+
+Roles are also used to control access to secrets. Each role is assigned an arbitrary number of groups and/or users. Only the users associated with a role have permission to decrypt the secrets assigned to that role. (A superuser has permission to decrypt all secrets, provided they have an active user key.)
+
+---
+
+# User Keys
+
+Each user within NetBox can associate his or her account with an RSA public key. If activated by an administrator, this user key will contain a unique, encrypted copy of the AES master key needed to retrieve secret data.
+
+User keys may be created by users individually, however they are of no use until they have been activated by a user who already possesses an active user key.
+
+## Creating the First User Key
+
+When NetBox is first installed, it contains no encryption keys. Before it can store secrets, a user (typically the superuser) must create a user key. This can be done by navigating to Profile > User Key.
+
+To create a user key, you can either generate a new RSA key pair, or upload the public key belonging to a pair you already have. If generating a new key pair, **you must save the private key** locally before saving your new user key. Once your user key has been created, its public key will be displayed under your profile.
+
+When the first user key is created in NetBox, a random master encryption key is generated automatically. This key is then encrypted using the public key provided and stored as part of your user key. **The master key cannot be recovered** without your private key.
+
+Once a user key has been assigned an encrypted copy of the master key, it is considered activated and can now be used to encrypt and decrypt secrets.
+
+## Creating Additional User Keys
+
+Any user can create his or her user key by generating or uploading a public RSA key. However, a user key cannot be used to encrypt or decrypt secrets until it has been activated with an encrypted copy of the master key.
+
+Only an administrator with an active user key can activate other user keys. To do so, access the NetBox admin UI and navigate to Secrets > User Keys. Select the user key(s) to be activated, and select "activate selected user keys" from the actions dropdown. You will need to provide your private key in order to decrypt the master key. A copy of the master key is then encrypted using the public key associated with the user key being activated.

docs/data-model/tenancy.md

@@ -0,0 +1,20 @@
+NetBox supports the assignment of resources to tenant organizations. Typically, these are used to represent individual customers of or internal departments within the organization using NetBox.
+
+# Tenants
+
+A tenant represents a discrete organization. The following objects can be assigned to tenants:
+
+* Sites
+* Racks
+* Devices
+* VRFs
+* Prefixes
+* IP addresses
+* VLANs
+* Circuits
+
+If a prefix or IP address is not assigned to a tenant, it will appear to inherit the tenant to which its parent VRF is assigned, if any.
+
+### Tenant Groups
+
+Tenants can be grouped by type. For instance, you might create one group called "Customers" and one called "Acquisitions." The assignment of tenants to groups is optional.

docs/data-model/virtualization.md

@@ -0,0 +1,29 @@
+NetBox supports the definition of virtual machines arranged in clusters. A cluster can optionally have physical host devices associated with it.
+
+# Clusters
+
+A cluster is a logical grouping of physical resources within which virtual machines run. A cluster must be assigned a type, and may optionally be assigned an organizational group.
+
+Physical devices (from NetBox's DCIM component) may be associated with clusters as hosts. This allows users to track on which host(s) a particular VM may reside. However, NetBox does not support pinning a specific VM within a cluster to a particular host device.
+
+### Cluster Types
+
+A cluster type represents a technology or mechanism by which a cluster is formed. For example, you might create a cluster type named "VMware vSphere" for a locally hosted cluster or "DigitalOcean NYC3" for one hosted by a cloud provider.
+
+### Cluster Groups
+
+Cluster groups may be created for the purpose of organizing clusters.
+
+---
+
+# Virtual Machines
+
+A virtual machine represents a virtual compute instance hosted within a cluster. Each VM must be associated with exactly one cluster.
+
+Like devices, each VM can have interfaces created on it. These behave similarly to device interfaces, and can be assigned IP addresses, however given their virtual nature they cannot be connected to other interfaces. VMs can also be assigned layer four services. Unlike physical devices, VMs cannot be assigned console or power ports, or device bays.
+
+The following resources can be defined for each VM:
+
+* vCPU count
+* Memory (MB)
+* Disk space (GB)

docs/development/adding-models.md

@@ -1,92 +0,0 @@
-# Adding Models
-
-## 1. Define the model class
-
-Models within each app are stored in either `models.py` or within a submodule under the `models/` directory. When creating a model, be sure to subclass the [appropriate base model](models.md) from `netbox.models`. This will typically be NetBoxModel or OrganizationalModel. Remember to add the model class to the `__all__` listing for the module.
-
-Each model should define, at a minimum:
-
-* A `Meta` class specifying a deterministic ordering (if ordered by fields other than the primary ID)
-* A `__str__()` method returning a user-friendly string representation of the instance
-* A `get_absolute_url()` method returning an instance's direct URL (using `reverse()`)
-
-## 2. Define field choices
-
-If the model has one or more fields with static choices, define those choices in `choices.py` by subclassing `utilities.choices.ChoiceSet`.
-
-## 3. Generate database migrations
-
-Once your model definition is complete, generate database migrations by running `manage.py makemigrations -n $NAME --no-header`. Always specify a short unique name when generating migrations.
-
-!!! info "Configuration Required"
-    Set `DEVELOPER = True` in your NetBox configuration to enable the creation of new migrations.
-
-## 4. Add all standard views
-
-Most models will need view classes created in `views.py` to serve the following operations:
-
-* List view
-* Detail view
-* Edit view
-* Delete view
-* Bulk import
-* Bulk edit
-* Bulk delete
-
-## 5. Add URL paths
-
-Add the relevant URL path for each view created in the previous step to `urls.py`.
-
-## 6. Add relevant forms
-
-Depending on the type of model being added, you may need to define several types of form classes. These include:
-
-* A base model form (for creating/editing individual objects)
-* A bulk edit form
-* A bulk import form (for CSV-based import)
-* A filterset form (for filtering the object list view)
-
-## 7. Create the FilterSet
-
-Each model should have a corresponding FilterSet class defined. This is used to filter UI and API queries. Subclass the appropriate class from `netbox.filtersets` that matches the model's parent class.
-
-## 8. Create the table class
-
-Create a table class for the model in `tables.py` by subclassing `utilities.tables.BaseTable`. Under the table's `Meta` class, be sure to list both the fields and default columns.
-
-## 9. Create the object template
-
-Create the HTML template for the object view. (The other views each typically employ a generic template.) This template should extend `generic/object.html`.
-
-## 10. Add the model to the navigation menu
-
-Add the relevant navigation menu items in `netbox/netbox/navigation_menu.py`.
-
-## 11. REST API components
-
-Create the following for each model:
-
-* Detailed (full) model serializer in `api/serializers.py`
-* Nested serializer in `api/nested_serializers.py`
-* API view in `api/views.py`
-* Endpoint route in `api/urls.py`
-
-## 12. GraphQL API components
-
-Create a Graphene object type for the model in `graphql/types.py` by subclassing the appropriate class from `netbox.graphql.types`.
-
-Also extend the schema class defined in `graphql/schema.py` with the individual object and object list fields per the established convention.
-
-## 13. Add tests
-
-Add tests for the following:
-
-* UI views
-* API views
-* Filter sets
-
-## 14. Documentation
-
-Create a new documentation page for the model in `docs/models/<app_label>/<model_name>.md`. Include this file under the "features" documentation where appropriate.
-
-Also add your model to the index in `docs/development/models.md`.

docs/development/application-registry.md

@@ -1,57 +0,0 @@
-# Application Registry
-
-The registry is an in-memory data structure which houses various application-wide parameters, such as the list of enabled plugins. It is not exposed to the user and is not intended to be modified by any code outside of NetBox core.
-
-The registry behaves essentially like a Python dictionary, with the notable exception that once a store (key) has been declared, it cannot be deleted or overwritten. The value of a store can, however, be modified; e.g. by appending a value to a list. Store values generally do not change once the application has been initialized.
-
-The registry can be inspected by importing `registry` from `extras.registry`.
-
-## Stores
-
-### `model_features`
-
-A dictionary of particular features (e.g. custom fields) mapped to the NetBox models which support them, arranged by app. For example:
-
-```python
-{
-    'custom_fields': {
-        'circuits': ['provider', 'circuit'],
-        'dcim': ['site', 'rack', 'devicetype', ...],
-        ...
-    },
-    'webhooks': {
-        ...
-    },
-    ...
-}
-```
-
-### `plugin_menu_items`
-
-Navigation menu items provided by NetBox plugins. Each plugin is registered as a key with the list of menu items it provides. An example:
-
-```python
-{
-    'Plugin A': (
-        <MenuItem>, <MenuItem>, <MenuItem>,
-    ),
-    'Plugin B': (
-        <MenuItem>, <MenuItem>, <MenuItem>,
-    ),
-}
-```
-
-### `plugin_template_extensions`
-
-Plugin content that gets embedded into core NetBox templates. The store comprises NetBox models registered as dictionary keys, each pointing to a list of applicable template extension classes that exist. An example:
-
-```python
-{
-    'dcim.site': [
-        <TemplateExtension>, <TemplateExtension>, <TemplateExtension>,
-    ],
-    'dcim.rack': [
-        <TemplateExtension>, <TemplateExtension>,
-    ],
-}
-```

docs/development/extending-models.md

@@ -1,77 +0,0 @@
-# Extending Models
-
-Below is a list of tasks to consider when adding a new field to a core model.
-
-## 1. Generate and run database migrations
-
-[Django migrations](https://docs.djangoproject.com/en/stable/topics/migrations/) are used to express changes to the database schema. In most cases, Django can generate these automatically, however very complex changes may require manual intervention. Always remember to specify a short but descriptive name when generating a new migration.
-
-```
-./manage.py makemigrations <app> -n <name>
-./manage.py migrate
-```
-
-Where possible, try to merge related changes into a single migration. For example, if three new fields are being added to different models within an app, these can be expressed in a single migration. You can merge a newly generated migration with an existing one by combining their `operations` lists.
-
-!!! warning "Do not alter existing migrations"
-    Migrations can only be merged within a release. Once a new release has been published, its migrations cannot be altered (other than for the purpose of correcting a bug).
-
-## 2. Add validation logic to `clean()`
-
-If the new field introduces additional validation requirements (beyond what's included with the field itself), implement them in the model's `clean()` method. Remember to call the model's original method using `super()` before or after your custom validation as appropriate:
-
-```
-class Foo(models.Model):
-
-    def clean(self):
-        super().clean()
-
-        # Custom validation goes here
-        if self.bar is None:
-            raise ValidationError()
-```
-
-## 3. Update relevant querysets
-
-If you're adding a relational field (e.g. `ForeignKey`) and intend to include the data when retrieving a list of objects, be sure to include the field using `prefetch_related()` as appropriate. This will optimize the view and avoid extraneous database queries.
-
-## 4. Update API serializer
-
-Extend the model's API serializer in `<app>.api.serializers` to include the new field. In most cases, it will not be necessary to also extend the nested serializer, which produces a minimal representation of the model.
-
-## 5. Add fields to forms
-
-Extend any forms to include the new field(s) as appropriate. These are found under the `forms/` directory within each app. Common forms include:
-
-* **Credit/edit** - Manipulating a single object
-* **Bulk edit** - Performing a change on many objects at once
-* **CSV import** - The form used when bulk importing objects in CSV format
-* **Filter** - Displays the options available for filtering a list of objects (both UI and API)
-
-## 6. Extend object filter set
-
-If the new field should be filterable, add it to the `FilterSet` for the model. If the field should be searchable, remember to query it in the FilterSet's `search()` method.
-
-## 7. Add column to object table
-
-If the new field will be included in the object list view, add a column to the model's table. For simple fields, adding the field name to `Meta.fields` will be sufficient. More complex fields may require declaring a custom column. Also add the field name to `default_columns` if the column should be present in the table by default.
-
-## 8. Update the UI templates
-
-Edit the object's view template to display the new field. There may also be a custom add/edit form template that needs to be updated.
-
-## 9. Create/extend test cases
-
-Create or extend the relevant test cases to verify that the new field and any accompanying validation logic perform as expected. This is especially important for relational fields. NetBox incorporates various test suites, including:
-
-* API serializer/view tests
-* Filter tests
-* Form tests
-* Model tests
-* View tests
-
-Be diligent to ensure all of the relevant test suites are adapted or extended as necessary to test any new functionality.
-
-## 10. Update the model's documentation
-
-Each model has a dedicated page in the documentation, at `models/<app>/<model>.md`. Update this file to include any relevant information about the new field.

docs/development/getting-started.md

@@ -1,202 +0,0 @@
-# Getting Started
-
-## Setting up a Development Environment
-
-Getting started with NetBox development is pretty straightforward, and should feel very familiar to anyone with Django development experience. There are a few things you'll need:
-
-* A Linux system or compatible environment
-* A PostgreSQL server, which can be installed locally [per the documentation](../installation/1-postgresql.md)
-* A Redis server, which can also be [installed locally](../installation/2-redis.md)
-* Python 3.8 or later
-
-### 1. Fork the Repo
-
-Assuming you'll be working on your own fork, your first step will be to fork the [official git repository](https://github.com/netbox-community/netbox). (If you're a maintainer who's going to be working directly with the official repo, skip this step.) Click the "fork" button at top right (be sure that you've logged into GitHub first).
-
-![GitHub fork button](../media/development/github_fork_button.png)
-
-Copy the URL provided in the dialog box.
-
-![GitHub fork dialog](../media/development/github_fork_dialog.png)
-
-You can then clone your GitHub fork locally for development:
-
-```no-highlight hl_lines="1 9"
-$ git clone https://github.com/$username/netbox.git
-Cloning into 'netbox'...
-remote: Enumerating objects: 85949, done.
-remote: Counting objects: 100% (4672/4672), done.
-remote: Compressing objects: 100% (1224/1224), done.
-remote: Total 85949 (delta 3538), reused 4332 (delta 3438), pack-reused 81277
-Receiving objects: 100% (85949/85949), 55.16 MiB | 44.90 MiB/s, done.
-Resolving deltas: 100% (68008/68008), done.
-$ ls netbox/
-base_requirements.txt  contrib          docs         mkdocs.yml  NOTICE     requirements.txt  upgrade.sh
-CHANGELOG.md           CONTRIBUTING.md  LICENSE.txt  netbox      README.md  scripts
-```
-
-### 2. Create a New Branch
-
-The NetBox project utilizes three persistent git branches to track work:
-
-* `master` - Serves as a snapshot of the current stable release
-* `develop` - All development on the upcoming stable (patch) release occurs here
-* `feature` - Tracks work on an upcoming minor release
-
-Typically, you'll base pull requests off of the `develop` branch, or off of `feature` if you're working on a new major release. For example, assume that the current NetBox release is v3.3.5. Work applied to the `develop` branch will appear in v3.3.6, and work done under the `feature` branch will be included in the next minor release (v3.4.0).
-
-!!! warning
-    **Never** merge pull requests into the `master` branch: This branch only ever merges pull requests from the `develop` branch, to effect a new release.
-
-To create a new branch, first ensure that you've checked out the desired base branch, then run:
-
-```no-highlight
-git checkout -B $branchname
-```
-
-When naming a new git branch, contributors are strongly encouraged to use the relevant issue number followed by a very brief description of the work:
-
-```no-highlight
-$issue-$description
-```
-
-The description should be just two or three words to imply the focus of the work being performed. For example, bug #1234 to fix a TypeError exception when creating a device might be named `1234-device-typerror`. This ensures that branches are always follow some logical ordering (e.g. when running `git branch -a`) and helps other developers quickly identify the purpose of each.
-
-### 3. Enable Pre-Commit Hooks
-
-NetBox ships with a [git pre-commit hook](https://githooks.com/) script that automatically checks for style compliance and missing database migrations prior to committing changes. This helps avoid erroneous commits that result in CI test failures. You are encouraged to enable it by creating a link to `scripts/git-hooks/pre-commit`:
-
-```no-highlight
-cd .git/hooks/
-ln -s ../../scripts/git-hooks/pre-commit
-```
-For the pre-commit hooks to work, you will also need to install the pycodestyle package:
-
-```no-highlight
-python -m pip install pycodestyle
-```
-...and set up the yarn packages as shown in the [Web UI Development Guide](web-ui.md)
-
-### 4. Create a Python Virtual Environment
-
-A [virtual environment](https://docs.python.org/3/tutorial/venv.html) (or "venv" for short) is like a container for a set of Python packages. These allow you to build environments suited to specific projects without interfering with system packages or other projects. When installed per the documentation, NetBox uses a virtual environment in production.
-
-Create a virtual environment using the `venv` Python module:
-
-```no-highlight
-mkdir ~/.venv
-python3 -m venv ~/.venv/netbox
-```
-
-This will create a directory named `.venv/netbox/` in your home directory, which houses a virtual copy of the Python executable and its related libraries and tooling. When running NetBox for development, it will be run using the Python binary at `~/.venv/netbox/bin/python`.
-
-!!! tip "Virtual Environments"
-    Keeping virtual environments in `~/.venv/` is a common convention but entirely optional: Virtual environments can be created almost wherever you please. Also consider using [`virtualenvwrapper`](https://virtualenvwrapper.readthedocs.io/en/stable/) to simplify the management of multiple environments.
-
-Once created, activate the virtual environment:
-
-```no-highlight
-source ~/.venv/netbox/bin/activate
-```
-
-Notice that the console prompt changes to indicate the active environment. This updates the necessary system environment variables to ensure that any Python scripts are run within the virtual environment.
-
-### 5. Install Required Packages
-
-With the virtual environment activated, install the project's required Python packages using the `pip` module. Required packages are defined in `requirements.txt`. Each line in this file specifies the name and specific version of a required package.
-
-```no-highlight
-python -m pip install -r requirements.txt
-```
-
-### 6. Configure NetBox
-
-Within the `netbox/netbox/` directory, copy `configuration_example.py` to `configuration.py` and update the following parameters:
-
-* `ALLOWED_HOSTS`: This can be set to `['*']` for development purposes
-* `DATABASE`: PostgreSQL database connection parameters
-* `REDIS`: Redis configuration (if different from the defaults)
-* `SECRET_KEY`: Set to a random string (use `generate_secret_key.py` in the parent directory to generate a suitable key)
-* `DEBUG`: Set to `True`
-* `DEVELOPER`: Set to `True` (this enables the creation of new database migrations)
-
-### 7. Start the Development Server
-
-Django provides a lightweight, auto-updating [HTTP/WSGI server](https://docs.djangoproject.com/en/stable/ref/django-admin/#runserver) for development use. It is started with the `runserver` management command:
-
-```no-highlight hl_lines="1"
-$ ./manage.py runserver
-Performing system checks...
-
-System check identified no issues (0 silenced).
-August 18, 2022 - 15:17:52
-Django version 4.0.7, using settings 'netbox.settings'
-Starting development server at http://127.0.0.1:8000/
-Quit the server with CONTROL-C.
-```
-
-This ensures that your development environment is now complete and operational. The development server will monitor the development environment and automatically reload in response to any changes made.
-
-!!! tip "IDE Integration"
-    Some IDEs, such as the highly-recommended [PyCharm](https://www.jetbrains.com/pycharm/), will integrate with Django's development server and allow you to run it directly within the IDE. This is strongly encouraged as it makes for a much more convenient development environment.
-
-## UI Development
-
-For UI development you will need to review the [Web UI Development Guide](web-ui.md)
-
-## Populating Demo Data
-
-Once you have your development environment up and running, it might be helpful to populate some "dummy" data to make interacting with the UI and APIs more convenient. Check out the [netbox-demo-data](https://github.com/netbox-community/netbox-demo-data) repo on GitHub, which houses a collection of sample data that can be easily imported to any new NetBox deployment. (This sample data is used to populate the public demo instance at <https://demo.netbox.dev>.)
-
-The demo data is provided in JSON format and loaded into an empty database using Django's `loaddata` management command. Consult the demo data repo's `README` file for complete instructions on populating the data.
-
-## Running Tests
-
-Prior to committing any substantial changes to the code base, be sure to run NetBox's test suite to catch potential errors. Tests are run using the `test` management command, which employs Python's [`unittest`](https://docs.python.org/3/library/unittest.html#module-unittest) library. Remember to ensure that the Python virtual environment is active before running this command. Also keep in mind that these commands are executed in the `netbox/` directory, not the root directory of the repository.
-
-To avoid potential issues with your local configuration file, set the `NETBOX_CONFIGURATION` to point to the packaged test configuration at `netbox/configuration_testing.py`. This will handle things like ensuring that the dummy plugin is enabled for comprehensive testing.
-
-```no-highlight
-export NETBOX_CONFIGURATION=netbox.configuration_testing
-cd netbox/
-python manage.py test
-```
-
-In cases where you haven't made any changes to the database schema (which is typical), you can append the `--keepdb` argument to this command to reuse the test database between runs. This cuts down on the time it takes to run the test suite since the database doesn't have to be rebuilt each time. (Note that this argument will cause errors if you've modified any model fields since the previous test run.)
-
-```no-highlight
-python manage.py test --keepdb
-```
-
-You can also reduce testing time by enabling parallel test execution with the `--parallel` flag. (By default, this will run as many parallel tests as you have processors. To avoid sluggishness, it's a good idea to specify a lower number of parallel tests.) This flag can be combined with `--keepdb`, although if you encounter any strange errors, try running the test suite again with parallelization disabled.
-
-```no-highlight
-python manage.py test --parallel <n>
-```
-
-Finally, it's possible to limit the run to a specific set of tests, specified by their Python path. For example, to run only IPAM and DCIM view tests:
-
-```no-highlight
-python manage.py test dcim.tests.test_views ipam.tests.test_views
-```
-
-This is handy for instances where just a few tests are failing and you want to re-run them individually.
-
-!!! info
-    NetBox uses [django-rich](https://github.com/adamchainz/django-rich) to enhance Django's default `test` management command.
-
-## Submitting Pull Requests
-
-Once you're happy with your work and have verified that all tests pass, commit your changes and push it upstream to your fork. Always provide descriptive (but not excessively verbose) commit messages. Be sure to prefix your commit message with the word "Fixes" or "Closes" and the relevant issue number (with a hash mark). This tells GitHub to automatically close the referenced issue once the commit has been merged.
-
-```no-highlight
-git commit -m "Closes #1234: Add IPv5 support"
-git push origin
-```
-
-Once your fork has the new commit, submit a [pull request](https://github.com/netbox-community/netbox/compare) to the NetBox repo to propose the changes. Be sure to provide a detailed accounting of the changes being made and the reasons for doing so.
-
-Once submitted, a maintainer will review your pull request and either merge it or request changes. If changes are needed, you can make them via new commits to your fork: The pull request will update automatically.
-
-!!! warning
-    Remember, pull requests are permitted only for **accepted** issues. If an issue you want to work on hasn't been approved by a maintainer yet, it's best to avoid risking your time and effort on a change that might not be accepted. (The one exception to this is trivial changes to the documentation or other non-critical resources.)

docs/development/git-cheat-sheet.md

@@ -1,388 +0,0 @@
-# git Cheat Sheet
-
-This cheat sheet serves as a convenient reference for NetBox contributors who already somewhat familiar with using git. For a general introduction to the tooling and workflows involved, please see GitHub's guide [Getting started with git](https://docs.github.com/en/get-started/getting-started-with-git/setting-your-username-in-git).
-
-## Common Operations
-
-### Clone a Repo
-
-This copies a remote git repository (e.g. from GitHub) to your local workstation. It will create a new directory bearing the repo's name in the current path.
-
-``` title="Command"
-git clone https://github.com/$org-name/$repo-name
-```
-
-``` title="Example"
-$ git clone https://github.com/netbox-community/netbox
-Cloning into 'netbox'...
-remote: Enumerating objects: 95112, done.
-remote: Counting objects: 100% (682/682), done.
-remote: Compressing objects: 100% (246/246), done.
-remote: Total 95112 (delta 448), reused 637 (delta 436), pack-reused 94430
-Receiving objects: 100% (95112/95112), 60.40 MiB | 45.82 MiB/s, done.
-Resolving deltas: 100% (74979/74979), done.
-```
-
-### Pull New Commits
-
-To update your local branch with any recent upstream commits, run `git pull`.
-
-``` title="Command"
-git pull
-```
-
-``` title="Example"
-$ git pull
-remote: Enumerating objects: 1, done.
-remote: Counting objects: 100% (1/1), done.
-remote: Total 1 (delta 0), reused 0 (delta 0), pack-reused 0
-Unpacking objects: 100% (1/1), done.
-From https://github.com/netbox-community/netbox
-   28bc76695..e0741cc9a  develop    -> origin/develop
-Updating 28bc76695..e0741cc9a
-Fast-forward
- docs/release-notes/version-3.3.md | 1 +
- netbox/netbox/settings.py         | 1 +
- 2 files changed, 2 insertions(+)
-```
-
-### List Branches
-
-`git branch` lists all local branches. Appending `-a` to this command will list both local (green) and remote (red) branches.
-
-``` title="Command"
-git branch -a
-```
-
-``` title="Example"
-$ git branch -a
-* develop
-  remotes/origin/10170-changelog
-  remotes/origin/HEAD -> origin/develop
-  remotes/origin/develop
-  remotes/origin/feature
-  remotes/origin/master
-```
-
-### Switch Branches
-
-To switch to a different branch, use the `checkout` command.
-
-``` title="Command"
-git checkout $branchname
-```
-
-``` title="Example"
-$ git checkout feature
-Branch 'feature' set up to track remote branch 'feature' from 'origin'.
-Switched to a new branch 'feature'
-```
-
-### Create a New Branch
-
-Use the `-b` argument with `checkout` to create a new _local_ branch from the current branch.
-
-``` title="Command"
-git checkout -b $newbranch
-```
-
-``` title="Example"
-$ git checkout -b 123-fix-foo
-Switched to a new branch '123-fix-foo'
-```
-
-### Rename a Branch
-
-To rename the current branch, use the `git branch` command with the `-m` argument (for "modify").
-
-``` title="Command"
-git branch -m $newname
-```
-
-``` title="Example"
-$ git branch -m jstretch-testing
-$ git branch
-  develop
-  feature
-* jstretch-testing
-```
-
-### Merge a Branch
-
-To merge one branch into another, use the `git merge` command. Start by checking out the _destination_ branch, and merge the _source_ branch into it.
-
-``` title="Command"
-git merge $sourcebranch
-```
-
-``` title="Example"
-$ git checkout testing 
-Switched to branch 'testing'
-Your branch is up to date with 'origin/testing'.
-$ git merge branch2 
-Updating 9a12b5b5f..8ee42390b
-Fast-forward
- newfile.py | 0
- 1 file changed, 0 insertions(+), 0 deletions(-)
- create mode 100644 newfile.py
-```
-
-!!! warning "Avoid Merging Remote Branches"
-    You generally want to avoid merging branches that exist on the remote (upstream) repository, such as `develop` and `feature`: Merges into these branches should be done via a pull request on GitHub. Only merge branches when it is necessary to consolidate work you've done locally.
-
-### Show Pending Changes
-
-After making changes to files in the repo, `git status` will display a summary of created, modified, and deleted files.
-
-``` title="Command"
-git status
-```
-
-``` title="Example"
-$ git status
-On branch 123-fix-foo
-Changes not staged for commit:
-  (use "git add <file>..." to update what will be committed)
-  (use "git checkout -- <file>..." to discard changes in working directory)
-
-	modified:   README.md
-
-Untracked files:
-  (use "git add <file>..." to include in what will be committed)
-
-	foo.py
-
-no changes added to commit (use "git add" and/or "git commit -a")
-```
-
-### Stage Changed Files
-
-Before creating a new commit, modified files must be staged. This is typically done with the `git add` command. You can specify a particular path, or just append `-A` to automatically staged _all_ changed files within the current directory. Run `git status` again to verify what files have been staged.
-
-``` title="Command"
-git add -A
-```
-
-``` title="Example"
-$ git add -A
-$ git status
-On branch 123-fix-foo
-Changes to be committed:
-  (use "git reset HEAD <file>..." to unstage)
-
-	modified:   README.md
-	new file:   foo.py
-
-```
-
-### Review Staged Files
-
-It's a good idea to thoroughly review all staged changes immediately prior to creating a new commit. This can be done using the `git diff` command. Appending the `--staged` argument will show staged changes; omitting it will show changes that have not yet been staged.
-
-``` title="Command"
-git diff --staged
-```
-
-``` title="Example"
-$ git diff --staged
-diff --git a/README.md b/README.md
-index 93e125079..4344fb514 100644
---- a/README.md
-+++ b/README.md
-@@ -1,3 +1,8 @@
-+
-+Added some lines here
-+and here
-+and here too
-+
- <div align="center">
-   <img src="https://raw.githubusercontent.com/netbox-community/netbox/develop/docs/netbox_logo.svg" width="400" alt="NetBox logo" />
- </div>
-diff --git a/foo.py b/foo.py
-new file mode 100644
-index 000000000..e69de29bb
-```
-
-### Create a New Commit
-
-The `git commit` command records your changes to the current branch. Specify a commit message with the `-m` argument. (If omitted, a file editor will be opened to provide a message.
-
-``` title="Command"
-git commit -m "Fixes #123: Fixed the thing that was broken"
-```
-
-``` title="Example"
-$ git commit -m "Fixes #123: Fixed the thing that was broken"
-[123-fix-foo 9a12b5b5f] Fixes #123: Fixed the thing that was broken
- 2 files changed, 5 insertions(+)
- create mode 100644 foo.py
-```
-
-!!! tip "Automatically Closing Issues"
-    GitHub will [automatically close](https://github.blog/2013-01-22-closing-issues-via-commit-messages/) any issues referenced in a commit message by `Fixes:` or `Closes:` when the commit is merged into the repository's default branch. Contributors are strongly encouraged to follow this convention when forming commit messages. (Use "Closes" for feature requests and "Fixes" for bugs.)
-
-### Push a Commit Upstream
-
-Once you've made a commit locally, it needs to be pushed upstream to the _remote_ repository (typically called "origin"). This is done with the `git push` command. If this is a new branch that doesn't yet exist on the remote repository, you'll need to set the upstream for it when pushing.
-
-``` title="Command"
-git push -u origin $branchname
-```
-
-``` title="Example"
-$ git push -u origin testing
-Counting objects: 3, done.
-Delta compression using up to 16 threads.
-Compressing objects: 100% (3/3), done.
-Writing objects: 100% (3/3), 377 bytes | 377.00 KiB/s, done.
-Total 3 (delta 2), reused 0 (delta 0)
-remote: Resolving deltas: 100% (2/2), completed with 2 local objects.
-remote: 
-remote: Create a pull request for 'testing' on GitHub by visiting:
-remote:      https://github.com/netbox-community/netbox/pull/new/testing
-remote: 
-To https://github.com/netbox-community/netbox
- * [new branch]          testing -> testing
-Branch 'testing' set up to track remote branch 'testing' from 'origin'.
-```
-
-!!! tip
-    You can apply the following git configuration to automatically set the upstream for all new branches. This obviates the need to specify `-u origin`.
-    
-    ```
-    git config --global push.default current
-    ```
-
-## The GitHub CLI Client
-
-GitHub provides a [free CLI client](https://cli.github.com/) to simplify many aspects of interacting with GitHub repositories. Note that this utility is separate from `git`, and must be [installed separately](https://github.com/cli/cli#installation).
-
-This guide provides some examples of common operations, but be sure to check out the [GitHub CLI manual](https://cli.github.com/manual/) for a complete accounting of available commands.
-
-### List Open Pull Requests
-
-``` title="Command"
-gh pr list
-```
-
-``` title="Example"
-$ gh pr list
-
-Showing 3 of 3 open pull requests in netbox-community/netbox
-
-#10223  #7503 API Bulk-Create of Devices does not check Rack-Space  7503-bulkdevice             about 17 hours ago
-#9716   Closes #9599: Add cursor pagination mode                    lyuyangh:cursor-pagination  about 1 month ago
-#9498   Adds replication and adoption for module import             sleepinggenius2:issue_9361  about 2 months ago
-```
-
-### Check Out a PR
-
-This command will automatically check out the remote branch associated with an open pull request.
-
-``` title="Command"
-gh pr checkout $number
-```
-
-``` title="Example"
-$ gh pr checkout 10223
-Branch '7503-bulkdevice' set up to track remote branch '7503-bulkdevice' from 'origin'.
-Switched to a new branch '7503-bulkdevice'
-```
-
-## Fixing Mistakes
-
-### Modify the Previous Commit
-
-Sometimes you'll find that you've overlooked a necessary change and need to commit again. If you haven't pushed your most recent commit and just need to make a small tweak or two, you can _amend_ your most recent commit instead of creating a new one.
-
-First, stage the desired files with `git add` and verify the changes, the issue the `git commit` command with the `--amend` argument. You can also append the `--no-edit` argument if you would like to keep the previous commit message.
-
-``` title="Command"
-git commit --amend --no-edit
-```
-
-``` title="Example"
-$ git add -A
-$ git diff --staged
-$ git commit --amend --no-edit
-[testing 239b16921] Added a new file
- Date: Fri Aug 26 16:30:05 2022 -0400
- 2 files changed, 1 insertion(+)
- create mode 100644 newfile.py
-```
-
-!!! danger "Don't Amend After Pushing"
-    Never amend a commit you've already pushed upstream unless you're **certain** no one else is working on the same branch. Force-pushing will overwrite the change history, which will break any commits from other contributors. When in doubt, create a new commit instead.
-
-### Undo the Last Commit
-
-The `git reset` command can be used to undo the most recent commit. (`HEAD~` is equivalent to `HEAD~1` and references the commit prior to the current HEAD.) After making and staging your changes, commit using `-c ORIG_HEAD` to replace the erroneous commit.
-
-``` title="Command"
-git reset HEAD~
-```
-
-``` title="Example"
-$ git add -A
-$ git commit -m "Erroneous commit"
-[testing 09ce06736] Erroneous commit
- Date: Mon Aug 29 15:20:04 2022 -0400
- 1 file changed, 1 insertion(+)
- create mode 100644 BADCHANGE
-$ git reset HEAD~
-$ rm BADFILE
-$ git add -A
-$ git commit -m "Fixed commit"
-[testing c585709f3] Fixed commit
- Date: Mon Aug 29 15:22:38 2022 -0400
- 1 file changed, 65 insertions(+), 20 deletions(-)
-```
-
-!!! danger "Don't Reset After Pushing"
-    Resetting only works until you've pushed your local changes upstream. If you've already pushed upstream, use `git revert` instead. This will create a _new_ commit that reverts the erroneous one, but ensures that the git history remains intact.
-
-### Rebase from Upstream
-
-If a change has been pushed to the upstream branch since you most recently pulled it, attempting to push a new local commit will fail:
-
-```
-$ git push
-To https://github.com/netbox-community/netbox.git
- ! [rejected]            develop -> develop (fetch first)
-error: failed to push some refs to 'https://github.com/netbox-community/netbox.git'
-hint: Updates were rejected because the remote contains work that you do
-hint: not have locally. This is usually caused by another repository pushing
-hint: to the same ref. You may want to first integrate the remote changes
-hint: (e.g., 'git pull ...') before pushing again.
-hint: See the 'Note about fast-forwards' in 'git push --help' for details.
-```
-
-To resolve this, first fetch the upstream branch to update your local copy, and then [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) your local branch to include the new changes. Once the rebase has completed, you can push your local commits upstream.
-
-``` title="Commands"
-git fetch
-git rebase origin/$branchname
-```
-
-``` title="Example"
-$ git fetch
-remote: Enumerating objects: 1, done.
-remote: Counting objects: 100% (1/1), done.
-remote: Total 1 (delta 0), reused 0 (delta 0), pack-reused 0
-Unpacking objects: 100% (1/1), done.
-From https://github.com/netbox-community/netbox
-   815b2d8a2..8c35ebbb7  develop    -> origin/develop
-$ git rebase origin/develop
-First, rewinding head to replay your work on top of it...
-Applying: Further tweaks to the PR template
-Applying: Changelog for #10176, #10217
-$ git push
-Counting objects: 9, done.
-Delta compression using up to 16 threads.
-Compressing objects: 100% (9/9), done.
-Writing objects: 100% (9/9), 1.02 KiB | 1.02 MiB/s, done.
-Total 9 (delta 6), reused 0 (delta 0)
-remote: Resolving deltas: 100% (6/6), completed with 5 local objects.
-To https://github.com/netbox-community/netbox.git
-   8c35ebbb7..ada745324  develop -> develop
-```

docs/development/index.md

@@ -1,60 +0,0 @@
-# NetBox Development
-
-Thanks for your interest in contributing to NetBox! This introduction covers a few important things to know before you get started.
-
-## The Code
-
-NetBox and many of its related projects are maintained on [GitHub](https://github.com/netbox-community/netbox). GitHub also serves as one of our primary discussion forums. While all the code and discussion is publicly accessible, you'll need register for a [free GitHub account](https://github.com/signup) to engage in participation. Most people begin by [forking](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the NetBox repository under their own GitHub account to begin working on the code.
-
-![GitHub](../media/development/github.png)
-
-There are three permanent branches in the repository:
-
-* `master` - The current stable release. Individual changes should never be pushed directly to this branch, but rather merged from `develop`.
-* `develop` - Active development for the upcoming patch release. Pull requests will typically be based on this branch unless they introduce breaking changes that must be deferred until the next minor release.
-* `feature` - New feature work to be introduced in the next minor release (e.g. from v3.3 to v3.4).
-
-NetBox components are arranged into Django apps. Each app holds the models, views, and other resources relevant to a particular function:
-
-* `circuits`: Communications circuits and providers (not to be confused with power circuits)
-* `dcim`: Datacenter infrastructure management (sites, racks, and devices)
-* `extras`: Additional features not considered part of the core data model
-* `ipam`: IP address management (VRFs, prefixes, IP addresses, and VLANs)
-* `tenancy`: Tenants (such as customers) to which NetBox objects may be assigned
-* `users`: Authentication and user preferences
-* `utilities`: Resources which are not user-facing (extendable classes, etc.)
-* `virtualization`: Virtual machines and clusters
-* `wireless`: Wireless links and LANs
-
-All core functionality is stored within the `netbox/` subdirectory. HTML templates are stored in a common `templates/` directory, with model- and view-specific templates arranged by app. Documentation is kept in the `docs/` root directory.
-
-## Proposing Changes
-
-All substantial changes made to the code base are tracked using [GitHub issues](https://docs.github.com/en/issues). Feature requests, bug reports, and similar proposals must all be filed as issues and approved by a maintainer before work begins. This ensures that all changes to the code base are properly documented for future reference.
-
-To submit a new feature request or bug report for NetBox, select and complete the appropriate [issue template](https://github.com/netbox-community/netbox/issues/new/choose). Once your issue has been approved, you're welcome to submit a [pull request](https://docs.github.com/en/pull-requests) containing your proposed changes.
-
-![Opening a new GitHub issue](../media/development/github_new_issue.png)
-
-Check out our [issue intake policy](https://github.com/netbox-community/netbox/wiki/Issue-Intake-Policy) for an overview of the issue triage and approval processes.
-
-!!! tip
-    Avoid starting work on a proposal before it has been accepted. Not all proposed changes will be accepted, and we'd hate for you to waste time working on code that might not make it into the project.
-
-## Getting Help
-
-There are two primary forums for getting assistance with NetBox development:
-
-* [GitHub discussions](https://github.com/netbox-community/netbox/discussions) - The preferred forum for general discussion and support issues. Ideal for shaping a feature requests prior to submitting an issue.
-* [#netbox on NetDev Community Slack](https://netdev.chat/) - Good for quick chats. Avoid any discussion that might need to be referenced later on, as the chat history is not retained indefinitely.
-
-!!! note
-    Don't use GitHub issues to ask for help: These are reserved for proposed code changes only.
-
-## Governance
-
-NetBox follows the [benevolent dictator](http://oss-watch.ac.uk/resources/benevolentdictatorgovernancemodel) model of governance, with [Jeremy Stretch](https://github.com/jeremystretch) ultimately responsible for all changes to the code base. While community contributions are welcomed and encouraged, the lead maintainer's primary role is to ensure the project's long-term maintainability and continued focus on its primary functions.
-
-## Licensing
-
-The entire NetBox project is licensed as open source under the [Apache 2.0 license](https://github.com/netbox-community/netbox/blob/master/LICENSE.txt). This is a very permissive license which allows unlimited redistribution of all code within the project. Note that all submissions to the project are subject to the same license.

docs/development/models.md

@@ -1,107 +0,0 @@
-# NetBox Models
-
-## Model Types
-
-A NetBox model represents a discrete object type such as a device or IP address. Per [Django convention](https://docs.djangoproject.com/en/stable/topics/db/models/), each model is defined as a Python class and has its own SQL table. All NetBox data models can be categorized by type.
-
-The Django [content types](https://docs.djangoproject.com/en/stable/ref/contrib/contenttypes/) framework can be used to reference models within the database. A ContentType instance references a model by its `app_label` and `name`: For example, the Site model is referred to as `dcim.site`. The content type combined with an object's primary key form a globally unique identifier for the object (e.g. `dcim.site:123`).
-
-### Features Matrix
-
-* [Change logging](../features/change-logging.md) - Changes to these objects are automatically recorded in the change log
-* [Webhooks](../integrations/webhooks.md) - NetBox is capable of generating outgoing webhooks for these objects
-* [Custom fields](../customization/custom-fields.md) - These models support the addition of user-defined fields
-* [Export templates](../customization/export-templates.md) - Users can create custom export templates for these models
-* [Tagging](../models/extras/tag.md) - The models can be tagged with user-defined tags
-* [Journaling](../features/journaling.md) - These models support persistent historical commentary
-* Nesting - These models can be nested recursively to create a hierarchy
-
-| Type               | Change Logging   | Webhooks         | Custom Fields    | Export Templates | Tags             | Journaling       | Nesting          |
-| ------------------ | ---------------- | ---------------- |------------------| ---------------- | ---------------- | ---------------- | ---------------- |
-| Primary            | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: |                  |
-| Organizational     | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: |                  |                  |
-| Nested Group       | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: |                  | :material-check: |
-| Component          | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: |                  |                  |
-| Component Template | :material-check: | :material-check: |                  |                  |                  |                  |                  |
-
-## Models Index
-
-### Primary Models
-
-* [circuits.Circuit](../models/circuits/circuit.md)
-* [circuits.Provider](../models/circuits/provider.md)
-* [circuits.ProviderNetwork](../models/circuits/providernetwork.md)
-* [dcim.Cable](../models/dcim/cable.md)
-* [dcim.Device](../models/dcim/device.md)
-* [dcim.DeviceType](../models/dcim/devicetype.md)
-* [dcim.PowerFeed](../models/dcim/powerfeed.md)
-* [dcim.PowerPanel](../models/dcim/powerpanel.md)
-* [dcim.Rack](../models/dcim/rack.md)
-* [dcim.RackReservation](../models/dcim/rackreservation.md)
-* [dcim.Site](../models/dcim/site.md)
-* [dcim.VirtualChassis](../models/dcim/virtualchassis.md)
-* [ipam.Aggregate](../models/ipam/aggregate.md)
-* [ipam.ASN](../models/ipam/asn.md)
-* [ipam.FHRPGroup](../models/ipam/fhrpgroup.md)
-* [ipam.IPAddress](../models/ipam/ipaddress.md)
-* [ipam.IPRange](../models/ipam/iprange.md)
-* [ipam.L2VPN](../models/ipam/l2vpn.md)
-* [ipam.L2VPNTermination](../models/ipam/l2vpntermination.md)
-* [ipam.Prefix](../models/ipam/prefix.md)
-* [ipam.RouteTarget](../models/ipam/routetarget.md)
-* [ipam.Service](../models/ipam/service.md)
-* [ipam.VLAN](../models/ipam/vlan.md)
-* [ipam.VRF](../models/ipam/vrf.md)
-* [tenancy.Contact](../models/tenancy/contact.md)
-* [tenancy.Tenant](../models/tenancy/tenant.md)
-* [virtualization.Cluster](../models/virtualization/cluster.md)
-* [virtualization.VirtualMachine](../models/virtualization/virtualmachine.md)
-* [wireless.WirelessLAN](../models/wireless/wirelesslan.md)
-* [wireless.WirelessLink](../models/wireless/wirelesslink.md)
-
-### Organizational Models
-
-* [circuits.CircuitType](../models/circuits/circuittype.md)
-* [dcim.DeviceRole](../models/dcim/devicerole.md)
-* [dcim.Manufacturer](../models/dcim/manufacturer.md)
-* [dcim.Platform](../models/dcim/platform.md)
-* [dcim.RackRole](../models/dcim/rackrole.md)
-* [ipam.RIR](../models/ipam/rir.md)
-* [ipam.Role](../models/ipam/role.md)
-* [ipam.VLANGroup](../models/ipam/vlangroup.md)
-* [tenancy.ContactRole](../models/tenancy/contactrole.md)
-* [virtualization.ClusterGroup](../models/virtualization/clustergroup.md)
-* [virtualization.ClusterType](../models/virtualization/clustertype.md)
-
-### Nested Group Models
-
-* [dcim.Location](../models/dcim/location.md) (formerly RackGroup)
-* [dcim.Region](../models/dcim/region.md)
-* [dcim.SiteGroup](../models/dcim/sitegroup.md)
-* [tenancy.ContactGroup](../models/tenancy/contactgroup.md)
-* [tenancy.TenantGroup](../models/tenancy/tenantgroup.md)
-* [wireless.WirelessLANGroup](../models/wireless/wirelesslangroup.md)
-
-### Component Models
-
-* [dcim.ConsolePort](../models/dcim/consoleport.md)
-* [dcim.ConsoleServerPort](../models/dcim/consoleserverport.md)
-* [dcim.DeviceBay](../models/dcim/devicebay.md)
-* [dcim.FrontPort](../models/dcim/frontport.md)
-* [dcim.Interface](../models/dcim/interface.md)
-* [dcim.InventoryItem](../models/dcim/inventoryitem.md)
-* [dcim.PowerOutlet](../models/dcim/poweroutlet.md)
-* [dcim.PowerPort](../models/dcim/powerport.md)
-* [dcim.RearPort](../models/dcim/rearport.md)
-* [virtualization.VMInterface](../models/virtualization/vminterface.md)
-
-### Component Template Models
-
-* [dcim.ConsolePortTemplate](../models/dcim/consoleporttemplate.md)
-* [dcim.ConsoleServerPortTemplate](../models/dcim/consoleserverporttemplate.md)
-* [dcim.DeviceBayTemplate](../models/dcim/devicebaytemplate.md)
-* [dcim.FrontPortTemplate](../models/dcim/frontporttemplate.md)
-* [dcim.InterfaceTemplate](../models/dcim/interfacetemplate.md)
-* [dcim.PowerOutletTemplate](../models/dcim/poweroutlettemplate.md)
-* [dcim.PowerPortTemplate](../models/dcim/powerporttemplate.md)
-* [dcim.RearPortTemplate](../models/dcim/rearporttemplate.md)

docs/development/release-checklist.md

@@ -1,98 +0,0 @@
-# Release Checklist
-
-This documentation describes the process of packaging and publishing a new NetBox release. There are three types of release:
-
-* Major release (e.g. v2.11 to v3.0)
-* Minor release (e.g. v3.2 to v3.3)
-* Patch release (e.g. v3.3.0 to v3.3.1)
-
-While major releases generally introduce some very substantial change to the application, they are typically treated the same as minor version increments for the purpose of release packaging.
-
-## Minor Version Releases
-
-### Address Constrained Dependencies
-
-Sometimes it becomes necessary to constrain dependencies to a particular version, e.g. to work around a bug in a newer release or to avoid a breaking change that we have yet to accommodate. (Another common example is to limit the upstream Django release.) For example:
-
-```
-# https://github.com/encode/django-rest-framework/issues/6053
-djangorestframework==3.8.1
-```
-
-These version constraints are added to `base_requirements.txt` to ensure that newer packages are not installed when updating the pinned dependencies in `requirements.txt` (see the [Update Requirements](#update-requirements) section below). Before each new minor version of NetBox is released, all such constraints on dependent packages should be addressed if feasible. This guards against the collection of stale constraints over time.
-
-### Close the Release Milestone
-
-Close the [release milestone](https://github.com/netbox-community/netbox/milestones) on GitHub after ensuring there are no remaining open issues associated with it.
-
-### Update the Release Notes
-
-Check that a link to the release notes for the new version is present in the navigation menu (defined in `mkdocs.yml`), and that a summary of all major new features has been added to `docs/index.md`.
-
-### Manually Perform a New Install
-
-Start the documentation server and navigate to the current version of the installation docs:
-
-```no-highlight
-mkdocs serve
-```
-
-Follow these instructions to perform a new installation of NetBox in a temporary environment. This process must not be automated: The goal of this step is to catch any errors or omissions in the documentation, and ensure that it is kept up-to-date for each release. Make any necessary changes to the documentation before proceeding with the release.
-
-### Merge the Release Branch
-
-Submit a pull request to merge the `feature` branch into the `develop` branch in preparation for its release. Once it has been merged, continue with the section for patch releases below.
-
----
-
-## Patch Releases
-
-### Update Requirements
-
-Before each release, update each of NetBox's Python dependencies to its most recent stable version. These are defined in `requirements.txt`, which is updated from `base_requirements.txt` using `pip`. To do this:
-
-1. Upgrade the installed version of all required packages in your environment (`pip install -U -r base_requirements.txt`).
-2. Run all tests and check that the UI and API function as expected.
-3. Review each requirement's release notes for any breaking or otherwise noteworthy changes.
-4. Update the package versions in `requirements.txt` as appropriate.
-
-In cases where upgrading a dependency to its most recent release is breaking, it should be constrained to its current minor version in `base_requirements.txt` with an explanatory comment and revisited for the next major NetBox release (see the [Address Constrained Dependencies](#address-constrained-dependencies) section above).
-
-### Update Version and Changelog
-
-* Update the `VERSION` constant in `settings.py` to the new release version.
-* Update the example version numbers in the feature request and bug report templates under `.github/ISSUE_TEMPLATES/`.
-* Replace the "FUTURE" placeholder in the release notes with the current date.
-
-Commit these changes to the `develop` branch and push upstream.
-
-### Verify CI Build Status
-
-Ensure that continuous integration testing on the `develop` branch is completing successfully. If it fails, take action to correct the failure before proceding with the release.
-
-### Submit a Pull Request
-
-Submit a pull request titled **"Release vX.Y.Z"** to merge the `develop` branch into `master`. Copy the documented release notes into the pull request's body.
-
-Once CI has completed on the PR, merge it. This effects a new release in the `master` branch.
-
-### Create a New Release
-
-Create a [new release](https://github.com/netbox-community/netbox/releases/new) on GitHub with the following parameters.
-
-* **Tag:** Current version (e.g. `v3.3.1`)
-* **Target:** `master`
-* **Title:** Version and date (e.g. `v3.3.1 - 2022-08-25`)
-* **Description:** Copy from the pull request body
-
-Once created, the release will become available for users to install.
-
-### Update the Development Version
-
-On the `develop` branch, update `VERSION` in `settings.py` to point to the next release. For example, if you just released v3.3.1, set:
-
-```
-VERSION = 'v3.3.2-dev'
-```
-
-Commit this change with the comment "PRVB" (for _post-release version bump_) and push the commit upstream.

docs/development/signals.md

@@ -1,11 +0,0 @@
-# Signals
-
-In addition to [Django's built-in signals](https://docs.djangoproject.com/en/stable/topics/signals/), NetBox defines some of its own, listed below.
-
-## post_clean
-
-This signal is sent by models which inherit from `CustomValidationMixin` at the end of their `clean()` method.
-
-### Receivers
-
-* `extras.signals.run_custom_validators()`

docs/development/style-guide.md

@@ -1,79 +0,0 @@
-# Style Guide
-
-NetBox generally follows the [Django style guide](https://docs.djangoproject.com/en/stable/internals/contributing/writing-code/coding-style/), which is itself based on [PEP 8](https://www.python.org/dev/peps/pep-0008/). [Pycodestyle](https://github.com/pycqa/pycodestyle) is used to validate code formatting, ignoring certain violations.
-
-## Code
-
-### General Guidance
-
-* When in doubt, remain consistent: It is better to be consistently incorrect than inconsistently correct. If you notice in the course of unrelated work a pattern that should be corrected, continue to follow the pattern for now and submit a separate bug report so that the entire code base can be evaluated at a later point.
-
-* Prioritize readability over concision. Python is a very flexible language that typically offers several multiple options for expressing a given piece of logic, but some may be more friendly to the reader than others. (List comprehensions are particularly vulnerable to over-optimization.) Always remain considerate of the future reader who may need to interpret your code without the benefit of the context within which you are writing it.
-
-* Include a newline at the end of every file.
-
-* No easter eggs. While they can be fun, NetBox must be considered as a business-critical tool. The potential, however minor, for introducing a bug caused by unnecessary code is best avoided entirely.
-
-* Constants (variables which do not change) should be declared in `constants.py` within each app. Wildcard imports from the file are acceptable.
-
-* Every model must have a [docstring](https://peps.python.org/pep-0257/). Every custom method should include an explanation of its function.
-
-* Nested API serializers generate minimal representations of an object. These are stored separately from the primary serializers to avoid circular dependencies. Always import nested serializers from other apps directly. For example, from within the DCIM app you would write `from ipam.api.nested_serializers import NestedIPAddressSerializer`.
-
-### PEP 8 Exceptions
-
-NetBox ignores certain PEP8 assertions. These are listed below.
-
-#### Wildcard Imports
-
-Wildcard imports (for example, `from .constants import *`) are acceptable under any of the following conditions:
-
-* The library being import contains only constant declarations (e.g. `constants.py`)
-* The library being imported explicitly defines `__all__`
-
-#### Maximum Line Length (E501)
-
-NetBox does not restrict lines to a maximum length of 79 characters. We use a maximum line length of 120 characters, however this is not enforced by CI. The maximum length does not apply to HTML templates or to automatically generated code (e.g. database migrations).
-
-#### Line Breaks Following Binary Operators (W504)
-
-Line breaks are permitted following binary operators.
-
-### Enforcing Code Style
-
-The [`pycodestyle`](https://pypi.org/project/pycodestyle/) utility (formerly `pep8`) is used by the CI process to enforce code style. A [pre-commit hook](./getting-started.md#2-enable-pre-commit-hooks) which runs this automatically is included with NetBox. To invoke `pycodestyle` manually, run:
-
-```
-pycodestyle --ignore=W504,E501 netbox/
-```
-
-### Introducing New Dependencies
-
-The introduction of a new dependency is best avoided unless it is absolutely necessary. For small features, it's generally preferable to replicate functionality within the NetBox code base rather than to introduce reliance on an external project. This reduces both the burden of tracking new releases and our exposure to outside bugs and supply chain attacks.
-
-If there's a strong case for introducing a new dependency, it must meet the following criteria:
-
-* Its complete source code must be published and freely accessible without registration.
-* Its license must be conducive to inclusion in an open source project.
-* It must be actively maintained, with no longer than one year between releases.
-* It must be available via the [Python Package Index](https://pypi.org/) (PyPI).
-
-When adding a new dependency, a short description of the package and the URL of its code repository must be added to `base_requirements.txt`. Additionally, a line specifying the package name pinned to the current stable release must be added to `requirements.txt`. This ensures that NetBox will install only the known-good release.
-
-## Written Works
-
-### General Guidance
-
-* Written material must always meet a reasonable professional standard, with proper grammar, spelling, and punctuation.
-
-* Use two line breaks between paragraphs.
-
-* Use only a single space between sentences.
-
-* All documentation is to be written in [Markdown](../reference/markdown.md), with modest amounts of HTML permitted where needed to overcome technical limitations.
-
-### Branding
-
-* When referring to NetBox in writing, use the proper form "NetBox," with the letters N and B capitalized. The lowercase form "netbox" should be used in code, filenames, etc. but never "Netbox" or any other deviation.
-
-* There is an SVG form of the NetBox logo at [docs/netbox_logo.svg](../netbox_logo.svg). It is preferred to use this logo for all purposes as it scales to arbitrary sizes without loss of resolution. If a raster image is required, the SVG logo should be converted to a PNG image of the prescribed size.

docs/development/user-preferences.md

@@ -1,14 +0,0 @@
-# User Preferences
-
-The `users.UserConfig` model holds individual preferences for each user in the form of JSON data. This page serves as a manifest of all recognized user preferences in NetBox.
-
-## Available Preferences
-
-| Name                     | Description                                                   |
-|--------------------------|---------------------------------------------------------------|
-| data_format              | Preferred format when rendering raw data (JSON or YAML)       |
-| pagination.per_page      | The number of items to display per page of a paginated table  |
-| pagination.placement     | Where to display the paginator controls relative to the table |
-| tables.${table}.columns  | The ordered list of columns to display when viewing the table |
-| tables.${table}.ordering | A list of column names by which the table should be ordered   |
-| ui.colormode             | Light or dark mode in the user interface                      |

docs/development/utility-views.md

@@ -0,0 +1,53 @@
+# Utility Views
+
+Utility views are reusable views that handle common CRUD tasks, such as listing and updating objects. Some views operate on individual objects, whereas others (referred to as "bulk" views) operate on multiple objects at once.
+
+## Individual Views
+
+### ObjectListView
+
+Generates a paginated table of objects from a given queryset, which may optionally be filtered.
+
+### ObjectEditView
+
+Updates an object identified by a primary key (PK) or slug. If no existing object is specified, a new object will be created.
+
+### ObjectDeleteView
+
+Deletes an object. The user is redirected to a confirmation page before the deletion is executed.
+
+## Bulk Views
+
+### BulkCreateView
+
+Creates multiple objects at once based on a given pattern. Currently used only for IP addresses.
+
+### BulkImportView
+
+Accepts CSV-formatted data and creates a new object for each line. Creation is all-or-none.
+
+### BulkEditView
+
+Applies changes to multiple objects at once in a two-step operation. First, the list of PKs for selected objects is POSTed and an edit form is presented to the user. On submission of that form, the specified changes are made to all selected objects.
+
+### BulkDeleteView
+
+Deletes multiple objects. The user selects the objects to be deleted and confirms the deletion.
+
+## Component Views
+
+### ComponentCreateView
+
+Create one or more component objects beloning to a parent object (e.g. interfaces attached to a device).
+
+### ComponentEditView
+
+A subclass of `ObjectEditView`: Updates an individual component object.
+
+### ComponentDeleteView
+
+A subclass of `ObjectDeleteView`: Deletes an individual component object.
+
+### BulkComponentCreateView
+
+Create a set of components objects for each of a selected set of parent objects. This view can be used e.g. to create multiple interfaces on multiple devices at once.

docs/development/web-ui.md

@@ -1,99 +0,0 @@
-# Web UI Development
-
-## Front End Technologies
-
-The NetBox UI is built on languages and frameworks:
-
-### Styling & HTML Elements
-
-#### [Bootstrap](https://getbootstrap.com/) 5
-
-The majority of the NetBox UI is made up of stock Bootstrap components, with some styling modifications and custom components added on an as-needed basis. Bootstrap uses [Sass](https://sass-lang.com/), and NetBox extends Bootstrap's core Sass files for theming and customization.
-
-### Client-side Scripting
-
-#### [TypeScript](https://www.typescriptlang.org/)
-
-All client-side scripting is transpiled from TypeScript to JavaScript and served by Django. In development, TypeScript is an _extremely_ effective tool for accurately describing and checking the code, which leads to significantly fewer bugs, a better development experience, and more predictable/readable code.
-
-As part of the [bundling](#bundling) process, Bootstrap's JavaScript plugins are imported and bundled alongside NetBox's front-end code.
-
-!!! danger "NetBox is jQuery-free"
-    Following the Bootstrap team's deprecation of jQuery in Bootstrap 5, NetBox also no longer uses jQuery in front-end code.
-
-## Guidance
-
-NetBox generally follows the following guidelines for front-end code:
-
-- Bootstrap utility classes may be used to solve one-off issues or to implement singular components, as long as the class list does not exceed 4-5 classes. If an element needs more than 5 utility classes, a custom SCSS class should be added that contains the required style properties.
-- Custom classes must be commented, explaining the general purpose of the class and where it is used.
-- Reuse SCSS variables whenever possible. CSS values should (almost) never be hard-coded.
-- All TypeScript functions must have, at a minimum, a basic [JSDoc](https://jsdoc.app/) description of what the function is for and where it is used. If possible, document all function arguments via [`@param` JSDoc block tags](https://jsdoc.app/tags-param.html).
-- Expanding on NetBox's [dependency policy](style-guide.md#introducing-new-dependencies), new front-end dependencies should be avoided unless absolutely necessary. Every new front-end dependency adds to the CSS/JavaScript file size that must be loaded by the client and this should be minimized as much as possible. If adding a new dependency is unavoidable, use a tool like [Bundlephobia](https://bundlephobia.com/) to ensure the smallest possible library is used.
-- All UI elements must be usable on all common screen sizes, including mobile devices. Be sure to test newly implemented solutions (JavaScript included) on as many screen sizes and device types as possible.
-- NetBox aligns with Bootstrap's [supported Browsers and Devices](https://getbootstrap.com/docs/5.1/getting-started/browsers-devices/) list.
-
-## UI Development
-
-To contribute to the NetBox UI, you'll need to review the main [Getting Started guide](getting-started.md) in order to set up your base environment.
-
-### Tools
-
-Once you have a working NetBox development environment, you'll need to install a few more tools to work with the NetBox UI:
-
-- [NodeJS](https://nodejs.org/en/download/) (the LTS release should suffice)
-- [Yarn](https://yarnpkg.com/getting-started/install) (version 1)
-
-After Node and Yarn are installed on your system, you'll need to install all the NetBox UI dependencies:
-
-```console
-$ cd netbox/project-static
-$ yarn
-```
-
-!!! warning "Check Your Working Directory"
-    You need to be in the `netbox/project-static` directory to run the below `yarn` commands.
-
-### Bundling
-
-In order for the TypeScript and Sass (SCSS) source files to be usable by a browser, they must first be transpiled (TypeScript → JavaScript, Sass → CSS), bundled, and minified. After making changes to TypeScript or Sass source files, run `yarn bundle`.
-
-`yarn bundle` is a wrapper around the following subcommands, any of which can be run individually:
-
-| Command               | Action                                          |
-| :-------------------- | :---------------------------------------------- |
-| `yarn bundle`         | Bundle TypeScript and Sass (SCSS) source files. |
-| `yarn bundle:styles`  | Bundle Sass (SCSS) source files only.           |
-| `yarn bundle:scripts` | Bundle TypeScript source files only.            |
-
-All output files will be written to `netbox/project-static/dist`, where Django will pick them up when `manage.py collectstatic` is run.
-
-!!! info "Remember to re-run `manage.py collectstatic`"
-    If you're running the development web server — `manage.py runserver` — you'll need to run `manage.py collectstatic` to see your changes.
-
-### Linting, Formatting & Type Checking
-
-Before committing any changes to TypeScript files, and periodically throughout the development process, you should run `yarn validate` to catch formatting, code quality, or type errors.
-
-!!! tip "IDE Integrations"
-    If you're using an IDE, it is strongly recommended to install [ESLint](https://eslint.org/docs/user-guide/integrations), [TypeScript](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support), and [Prettier](https://prettier.io/docs/en/editors.html) integrations, if available. Most of them will automatically check and/or correct issues in the code as you develop, which can significantly increase your productivity as a contributor.
-
-`yarn validate` is a wrapper around the following subcommands, any of which can be run individually:
-
-| Command                            | Action                                                           |
-| :--------------------------------- | :--------------------------------------------------------------- |
-| `yarn validate`                    | Run all validation.                                              |
-| `yarn validate:lint`               | Validate TypeScript code via [ESLint](https://eslint.org/) only. |
-| `yarn validate:types`              | Validate TypeScript code compilation only.                       |
-| `yarn validate:formatting`         | Validate code formatting of JavaScript & Sass/SCSS files.        |
-| `yarn validate:formatting:styles`  | Validate code formatting Sass/SCSS only.                         |
-| `yarn validate:formatting:scripts` | Validate code formatting TypeScript only.                        |
-
-You can also run the following commands to automatically fix formatting issues:
-
-| Command               | Action                                          |
-| :-------------------- | :---------------------------------------------- |
-| `yarn format`         | Format TypeScript and Sass (SCSS) source files. |
-| `yarn format:styles`  | Format Sass (SCSS) source files only.           |
-| `yarn format:scripts` | Format TypeScript source files only.            |
-

docs/extra.css

@@ -1,29 +0,0 @@
-/* Images */
-img {
-    display: block;
-    margin-left: auto;
-    margin-right: auto;
-}
-
-/* Tables */
-table {
-    margin-bottom: 24px;
-    width: 100%;
-}
-th {
-    padding: 6px;
-    font-weight: bold;
-}
-td {
-    padding: 6px;
-}
-/* Remove table header coloring.  */
-.md-typeset table:not([class]) th {
-    color: unset !important;
-    background-color: unset !important;
-}
-thead tr {
-    /* Colorize table headers. */
-    background-color: var(--md-code-bg-color);
-    color: var(--md-code-fg-color);
-}

docs/features/api-integration.md

@@ -1,41 +0,0 @@
-# API & Integration
-
-NetBox includes a slew of features which enable integration with other tools and resources powering your network.
-
-## REST API
-
-NetBox's REST API, powered by the [Django REST Framework](https://www.django-rest-framework.org/), provides a robust yet accessible interface for creating, modifying, and deleting objects. Employing HTTP for transfer and JSON for data encapsulation, the REST API is easily consumed by clients on any platform and extremely well suited for automation tasks.
-
-```no-highlight
-curl -s -X POST \
--H "Authorization: Token $TOKEN" \
--H "Content-Type: application/json" \
-http://netbox/api/ipam/prefixes/ \
---data '{"prefix": "192.0.2.0/24", "site": {"name": "Branch 12"}}'
-```
-
-The REST API employs token-based authentication, which maps API clients to user accounts and their assigned permissions. The API endpoints are fully documented using OpenAPI, and NetBox even includes a convenient browser-based version of the API for exploration. The open source [pynetbox](https://github.com/netbox-community/pynetbox) and [go-netbox](https://github.com/netbox-community/go-netbox) API client libraries are also available for Python and Go, respectively.
-
-To learn more about this feature, check out the [REST API documentation](../integrations/rest-api.md).
-
-## GraphQL API
-
-NetBox also provides a [GraphQL](https://graphql.org/) API to complement its REST API. GraphQL enables complex queries for arbitrary objects and fields, enabling the client to retrieve only the specific data it needs from NetBox. This is a special-purpose read-only API intended for efficient queries. Like the REST API, the GraphQL API employs token-based authentication.
-
-To learn more about this feature, check out the [GraphQL API documentation](../integrations/graphql-api.md).
-
-## Webhooks
-
-A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system whenever the status of a device is updated in NetBox. This can be done by creating a webhook for the device model in NetBox and identifying the webhook receiver. When NetBox detects a change to a device, an HTTP request containing the details of the change and who made it be sent to the specified receiver. Webhooks are an excellent mechanism for building event-based automation processes.
-
-To learn more about this feature, check out the [webhooks documentation](../integrations/webhooks.md).
-
-## NAPALM
-
-[NAPALM](https://github.com/napalm-automation/napalm) is a Python library which enables direct interaction with network devices of various platforms. When configured, NetBox supports fetching live operational and status data directly from network devices to be compared to what has been defined in NetBox. This allows for easily validating the device's operational state against its desired state. Additionally, NetBox's REST API can act as a sort of proxy for NAPALM commands, allowing external clients to interact with network devices by sending HTTP requests to the appropriate API endpoint.
-
-To learn more about this feature, check out the [NAPALM documentation](../integrations/napalm.md).
-
-## Prometheus Metrics
-
-NetBox includes a special `/metrics` view which exposes metrics for a [Prometheus](https://prometheus.io/) scraper, powered by the open source [django-prometheus](https://github.com/korfuri/django-prometheus) library. To learn more about this feature, check out the [Prometheus metrics documentation](../integrations/prometheus-metrics.md).

docs/features/authentication-permissions.md

@@ -1,49 +0,0 @@
-# Authentication & Permissions
-
-## Object-Based Permissions
-
-NetBox boasts a very robust permissions system which extends well beyond the model-based permissions of the underlying Django framework. Assigning permissions in NetBox involves several dimensions:
-
-* The type(s) of object to which the permission applies
-* The users and/or groups being granted the permissions
-* The action(s) permitted by the permission (e.g. view, add, change, etc.)
-* Any constraints limiting application of the permission to a particular subset of objects
-
-The implementation of constrains is what enables NetBox administrators to assign per-object permissions: Users can be limited to viewing or interacting with arbitrary subsets of objects based on the objects' attributes. For example, you might restrict a particular user to viewing only those prefixes or IP addresses within a particular VRF. Or you might restrict a group to modifying devices within a particular region.
-
-Permission constraints are declared in JSON format when creating a permission, and operate very similarly to Django ORM queries. For instance, here's a constraint that matches reserved VLANs with a VLAN ID between 100 and 199:
-
-```json
-[
-  {
-    "vid__gte": 100,
-    "vid__lt": 200
-  },
-  {
-    "status": "reserved"
-  }
-]
-```
-
-Check out the [permissions documentation](../administration/permissions.md) for more information about permission constraints.
-
-## LDAP Authentication
-
-NetBox includes a built-in authentication backend for authenticating users against a remote LDAP server. The [installation documentation](../installation/6-ldap.md) provides more detail on this capability.
-
-## Single Sign-On (SSO)
-
-NetBox integrates with the open source [python-social-auth](https://github.com/python-social-auth) library to provide [myriad options](https://python-social-auth.readthedocs.io/en/latest/backends/index.html#supported-backends) for single sign-on (SSO) authentication. These include:
-
-* Cognito
-* GitHub & GitHub Enterprise
-* GitLab
-* Google
-* Hashicorp Vault
-* Keycloak
-* Microsoft Azure AD
-* Microsoft Graph
-* Okta
-* OIDC
-
-...and many others. It's also possible to build your own custom backends as needed using python-social-auth's base OAuth, OpenID, and SAML classes. You can find some examples of configuring SSO in NetBox' [authentication documentation](../administration/authentication/overview.md).

docs/features/change-logging.md

@@ -1,9 +0,0 @@
-# Change Logging
-
-Every time an object in NetBox is created, updated, or deleted, a serialized copy of that object taken both before and after the change is saved to the database, along with meta data including the current time and the user associated with the change. These records form a persistent record of changes both for each individual object as well as NetBox as a whole. The global change log can be viewed by navigating to Other > Change Log.
-
-A serialized representation of the instance being modified is included in JSON format. This is similar to how objects are conveyed within the REST API, but does not include any nested representations. For instance, the `tenant` field of a site will record only the tenant's ID, not a representation of the tenant.
-
-When a request is made, a UUID is generated and attached to any change records resulting from that request. For example, editing three objects in bulk will create a separate change record for each  (three in total), and each of those objects will be associated with the same UUID. This makes it easy to identify all the change records resulting from a particular request.
-
-Change records are exposed in the API via the read-only endpoint `/api/extras/object-changes/`. They may also be exported via the web UI in CSV format.

docs/features/circuits.md

@@ -1,33 +0,0 @@
-# Circuits
-
-NetBox is ideal for managing your network's transit and peering providers and circuits. It provides all the flexibility needed to model physical circuits in both data center and enterprise environments, and allows for "connecting" circuits directly to device interfaces via cables.
-
-```mermaid
-flowchart TD
-    ASN --> Provider
-    Provider --> ProviderNetwork & Circuit
-    CircuitType --> Circuit
-
-click ASN "../../models/circuits/asn/"
-click Circuit "../../models/circuits/circuit/"
-click CircuitType "../../models/circuits/circuittype/"
-click Provider "../../models/circuits/provider/"
-click ProviderNetwork "../../models/circuits/providernetwork/"
-```
-
-## Providers
-
-A provider is any organization which provides Internet or private connectivity. Typically, these are large carriers, however they might also include regional providers or even internal services. Each provider can be assigned account and contact details, and may have one or more AS numbers assigned to it.
-
-Sometimes you'll need to model provider networks into which you don't have full visibility; these are typically represented on topology diagrams with cloud icons. NetBox facilitates this through its provider network model: A provider network represents a "black box" network to which your circuits can connect. A common example is a provider MPLS network connecting multiple sites.
-
-## Circuits
-
-A circuit is a physical connection between two points, which is installed and maintained by an external provider. For example, an Internet connection delivered as a fiber optic cable would be modeled as a circuit in NetBox.
-
-Each circuit is associated with a provider and assigned a circuit ID, which must be unique to that provider. A circuit is also assigned a user-defined type, operational status, and various other operating characteristics.
-
-Each circuit may have up to two terminations (A and Z) defined. Each termination can be associated with a particular site or provider network. In the case of the former, a cable can be connected between the circuit termination and a device component to map its physical connectivity.
-
-!!! warning "Physical vs. Virtual Circuits"
-    The circuit model in NetBox represents **physical** connections. Don't confuse these with _virtual_ circuits which may be offered by providers overlaid on physical infrastructure. (For example, a VLAN-tagged subinterface would be a virtual circuit.) A good rule of thumb: If you can't point to it, it's not a physical circuit.

docs/features/contacts.md

@@ -1,45 +0,0 @@
-# Contacts
-
-Much like [tenancy](./tenancy.md), contact assignment enables you to track ownership of resources modeled in NetBox. A contact represents an individual responsible for a resource within the context of its assigned role.
-
-```mermaid
-flowchart TD
-    ContactGroup --> ContactGroup & Contact
-    ContactRole & Contact --> assignment([Assignment])
-    assignment --> Object
-
-click Contact "../../models/tenancy/contact/"
-click ContactGroup "../../models/tenancy/contactgroup/"
-click ContactRole "../../models/tenancy/contactrole/"
-```
-
-## Contact Groups
-
-Contacts can be grouped arbitrarily into a recursive hierarchy, and a contact can be assigned to a group at any level within the hierarchy.
-
-## Contact Roles
-
-A contact role defines the relationship of a contact to an assigned object. For example, you might define roles for administrative, operational, and emergency contacts.
-
-## Contacts
-
-A contact should represent an individual or permanent point of contact. Each contact must define a name, and may optionally include a title, phone number, email address, and related details.
-
-Contacts are reused for assignments, so each unique contact must be created only once and can be assigned to any number of NetBox objects, and there is no limit to the number of assigned contacts an object may have. Most core objects in NetBox can have contacts assigned to them.
-
-The following models support the assignment of contacts:
-
-* circuits.Circuit
-* circuits.Provider
-* dcim.Device
-* dcim.Location
-* dcim.Manufacturer
-* dcim.PowerPanel
-* dcim.Rack
-* dcim.Region
-* dcim.Site
-* dcim.SiteGroup
-* tenancy.Tenant
-* virtualization.Cluster
-* virtualization.ClusterGroup
-* virtualization.VirtualMachine

docs/features/context-data.md

@@ -1,84 +0,0 @@
-# Context Data
-
-Configuration context data (or "config contexts" for short) is a powerful feature that enables users to define arbitrary data that applies to device and virtual machines based on certain characteristics. For example, suppose you want to define syslog servers for devices assigned to sites within a particular region. In NetBox, you can create a config context instance containing this data and apply it to the desired region. All devices within this region will now include this data when fetched via an API.
-
-```json
-{
-    "syslog-servers": [
-        "192.168.43.107",
-        "192.168.48.112"
-    ]
-}
-```
-
-Config contexts can be computed for objects based on the following criteria:
-
-| Type          | Devices          | Virtual Machines |
-|---------------|------------------|------------------|
-| Region        | :material-check: | :material-check: |
-| Site group    | :material-check: | :material-check: |
-| Site          | :material-check: | :material-check: |
-| Location      | :material-check: |                  |
-| Device type   | :material-check: |                  |
-| Role          | :material-check: | :material-check: |
-| Platform      | :material-check: | :material-check: |
-| Cluster type  |                  | :material-check: |
-| Cluster group |                  | :material-check: |
-| Cluster       |                  | :material-check: |
-| Tenant group  | :material-check: | :material-check: |
-| Tenant        | :material-check: | :material-check: |
-| Tag           | :material-check: | :material-check: |
-
-There are no restrictions around what data can be stored in a configuration context, so long as it can be expressed in JSON.
-
-## Hierarchical Rendering
-
-While this is handy on its own, the real power of context data stems from its ability to be merged and overridden using multiple instances. For example, perhaps you need to define _different_ syslog servers within the region for a particular device role. You can create a second config context with the appropriate data and a higher weight, and apply it to the desired role. This will override the lower-weight data that applies to the entire region. As you can imagine, this flexibility can cater to many complex use cases.
-
-For example, suppose we want to specify a set of syslog and NTP servers for all devices within a region. We could create a config context instance with a weight of 1000 assigned to the region, with the following JSON data:
-
-```json
-{
-    "ntp-servers": [
-        "172.16.10.22",
-        "172.16.10.33"
-    ],
-    "syslog-servers": [
-        "172.16.9.100",
-        "172.16.9.101"
-    ]
-}
-```
-
-But suppose there's a problem at one particular site within this region preventing traffic from reaching the regional syslog server. Devices there need to use a local syslog server instead of the two defined above. We'll create a second config context assigned only to that site with a weight of 2000 and the following data:
-
-```json
-{
-    "syslog-servers": [
-        "192.168.43.107"
-    ]
-}
-```
-
-When the context data for a device at this site is rendered, the second, higher-weight data overwrite the first, resulting in the following:
-
-```json
-{
-    "ntp-servers": [
-        "172.16.10.22",
-        "172.16.10.33"
-    ],
-    "syslog-servers": [
-        "192.168.43.107"
-    ]
-}
-```
-
-Data from the higher-weight context overwrites conflicting data from the lower-weight context, while the non-conflicting portion of the lower-weight context (the list of NTP servers) is preserved.
-
-## Local Context Data
-
-Devices and virtual machines may also have a local context data defined. This local context will _always_ take precedence over any separate config context objects which apply to the device/VM. This is useful in situations where we need to call out a specific deviation in the data for a particular object.
-
-!!! warning
-    If you find that you're routinely defining local context data for many individual devices or virtual machines, [custom fields](./customization.md#custom-fields) may offer a more effective solution.

docs/features/customization.md

@@ -1,84 +0,0 @@
-# Customization
-
-While NetBox strives to meet the needs of every network, the needs of users to cater to their own unique environments cannot be ignored. NetBox was built with this in mind, and can be customized in many ways to better suit your particular needs.
-
-## Tags
-
-Most objects in NetBox can be assigned user-created tags to aid with organization and filtering. Tag values are completely arbitrary: They may be used to store data in key-value pairs, or they may be employed simply as labels against which objects can be filtered. Each tag can also be assigned a color for quicker differentiation in the user interface.
-
-Objects can be filtered by the tags they have applied. For example, the following API request will retrieve all devices tagged as "monitored":
-
-```no-highlight
-GET /api/dcim/devices/?tag=monitored
-```
-
-The `tag` filter can be specified multiple times to match only objects which have _all_ the specified tags assigned:
-
-```no-highlight
-GET /api/dcim/devices/?tag=monitored&tag=deprecated
-```
-
-## Custom Fields
-
-While NetBox provides a rather extensive data model out of the box, the need may arise to store certain additional data associated with NetBox objects. For example, you might need to record the invoice ID alongside an installed device, or record an approving authority when creating a new IP prefix. NetBox administrators can create custom fields on built-in objects to meet these needs.
-
-NetBox supports many types of custom field, from basic data types like strings and integers, to complex structures like selection lists or raw JSON. It's even possible to add a custom field which references other NetBox objects. Custom field data is stored directly alongside the object to which it is applied in the database, which ensures minimal performance impact. And custom field data can be written and read via the REST API, just like built-in fields.
-
-To learn more about this feature, check out the [custom field documentation](../customization/custom-fields.md).
-
-## Custom Links
-
-Custom links allow you to conveniently reference external resources related to NetBox objects from within the NetBox UI. For example, you might wish to link each virtual machine modeled in NetBox to its corresponding view in some orchestration application. You can do this by creating a templatized custom link for the virtual machine model, specifying something like the following for the link URL:
-
-```no-highlight
-http://server.local/vms/?name={{ object.name }}
-```
-
-Now, when viewing a virtual machine in NetBox, a user will see a handy button with the chosen title and link (complete with the name of the VM being viewed). Both the text and URL of custom links can be templatized in this manner, and custom links can be grouped together into dropdowns for more efficient display.
-
-To learn more about this feature, check out the [custom link documentation](../customization/custom-links.md).
-
-## Custom Validation
-
-While NetBox employs robust built-in object validation to ensure the integrity of its database, you might wish to enforce additional rules governing the creation and modification of certain objects. For example, perhaps you require that every device defined in NetBox adheres to a particular naming scheme and includes an asset tag. You can configure a custom validation rule in NetBox to enforce these requirements for the device model:
-
-```python
-CUSTOM_VALIDATORS = {
-    "dcim.device": [
-        {
-            "name": {
-                "regex": "[a-z]+\d{3}"
-            },
-            "asset_tag": {
-                "required": True
-            }
-        }
-    ]
-}
-```
-
-To learn more about this feature, check out the [custom validation documentation](../customization/custom-validation.md).
-
-## Export Templates
-
-Most NetBox objects can be exported in bulk in two built-in CSV formats: The current view (what the user currently sees in the objects list), or all available data. NetBox also provides the capability to define your own custom data export formats via export templates. An export template is essentially [Jinja2](https://jinja.palletsprojects.com/) template code associated with a particular object type. From the objects list in the NetBox UI, a user can select any of the created export templates to export the objects according to the template logic.
-
-An export template doesn't have to render CSV data: Its output can be in any character-based format. For example, you might want to render data using tabs as delimiters, or even create DNS address records directly from the IP addresses list. Export templates are a great way to get the data you need in the format you need quickly.
-
-To learn more about this feature, check out the [export template documentation](../customization/export-templates.md).
-
-## Reports
-
-NetBox administrators can install custom Python scripts, known as _reports_, which run within NetBox and can be executed and analyzed within the NetBox UI. Reports are a great way to evaluate NetBox objects against a set of arbitrary rules. For example, you could write a report to check that every router has a loopback interface with an IP address assigned, or that every site has a minimum set of VLANs defined.
-
-When a report runs, its logs messages pertaining to the operations being performed, and will ultimately result in either a pass or fail. Reports can be executed via the UI, REST API, or CLI (as a management command).
-
-To learn more about this feature, check out the [documentation for reports](../customization/reports.md).
-
-## Custom Scripts
-
-Custom scripts are similar to reports, but more powerful. A custom script can prompt the user for input via a form (or API data), and is built to do much more than just reporting. Custom scripts are generally used to automate tasks, such as the population of new objects in NetBox, or exchanging data with external systems.
-
-The complete Python environment is available to a custom script, including all of NetBox's internal mechanisms: There are no artificial restrictions on what a script can do. As such, custom scripting is considered an advanced feature and requires sufficient familiarity with Python and NetBox's data model.
-
-To learn more about this feature, check out the [documentation for custom scripts](../customization/custom-scripts.md).

docs/features/devices-cabling.md

@@ -1,87 +0,0 @@
-# Devices & Cabling
-
-At its heart, NetBox is a tool for modeling your network infrastructure, and the device object is pivotal to that function. A device can be any piece of physical hardware installed within your network, such as server, router, or switch, and may optionally be mounted within a rack. Within each device, resources such as network interfaces and console ports are modeled as discrete components, which may optionally be grouped into modules.
-
-NetBox uses device types to represent unique real-world device models. This allows a user to define a device type and all its components once, and easily replicate an unlimited number of device instances from it.
-
-```mermaid
-flowchart TD
-    Manufacturer -.-> Platform & DeviceType & ModuleType
-    Manufacturer --> DeviceType & ModuleType
-    DeviceRole & Platform & DeviceType --> Device
-    Device & ModuleType ---> Module
-    Device & Module --> Interface & ConsolePort & PowerPort & ...
-
-click Device "../../models/dcim/device/"
-click DeviceRole "../../models/dcim/devicerole/"
-click DeviceType "../../models/dcim/devicetype/"
-click Manufacturer "../../models/dcim/manufacturer/"
-click Module "../../models/dcim/module/"
-click ModuleType "../../models/dcim/moduletype/"
-click Platform "../../models/dcim/platform/"
-```
-
-## Manufacturers
-
-A manufacturer generally represents an organization which produces hardware devices. These can be defined by users, however they should represent an actual entity rather than some abstract idea.
-
-## Device Types
-
-A device type represents a unique combination of manufacturer and hardware model which maps to discrete make and model of device which exists in the real world. Each device type typically has a number of components created on it, representing network interfaces, device bays, and so on. New devices of this type can then be created in NetBox, and any associated components will be automatically replicated from the device type. This avoids needing to tediously recreate components for each device as it is added in NetBox.
-
-!!! tip "The Device Type Library"
-    While users are always free to create their own device types in NetBox, many find it convenient to draw from our [community library](https://github.com/netbox-community/devicetype-library) of pre-defined device types. This is possible because a particular make and model of device is applicable universally and never changes.
-
-All the following can be modeled as components:
-
-* Interfaces
-* Console ports
-* Console server ports
-* Power ports
-* Power outlets
-* Pass-through ports (front and rear)
-* Module bays (which house modules)
-* Device bays (which house child devices)
-
-For example, a Juniper EX4300-48T device type might have the following component templates defined:
-
-* One template for a console port ("Console")
-* Two templates for power ports ("PSU0" and "PSU1")
-* 48 templates for 1GE interfaces ("ge-0/0/0" through "ge-0/0/47")
-* Four templates for 10GE interfaces ("xe-0/2/0" through "xe-0/2/3")
-
-Once component templates have been created, every new device that you create as an instance of this type will automatically be assigned each of the components listed above.
-
-!!! note "Component Instantiation is not Retroactive"
-    The instantiation of components from a device type definition occurs only at the time of device creation. If you modify the components assigned to a device type, it will not affect devices which have already been created. This guards against any inadvertent changes to existing devices. However, you always have the option of adding, modifying, or deleting components on existing devices. (These changes can easily be applied to multiple devices at once using the bulk operations available in the UI.)
-
-## Devices
-
-Whereas a device type defines the make and model of a device, a device itself represents an actual piece of installed hardware somewhere in the real world. A device can be installed at a particular position within an equipment rack, or simply associated with a site (and optionally with a location within that site).
-
-Each device can have an operational status, functional role, and software platform assigned. Device components are instantiated automatically from the assigned device type upon creation.
-
-### Virtual Chassis
-
-Sometimes it is necessary to model a set of physical devices as sharing a single management plane. Perhaps the most common example of such a scenario is stackable switches. These can be modeled as virtual chassis in NetBox, with one device acting as the chassis master and the rest as members. All components of member devices will appear on the master.
-
-## Module Types & Modules
-
-Much like device types and devices, module types can instantiate discrete modules, which are hardware components installed within devices. Modules often have their own child components, which become available to the parent device. For example, when modeling a chassis-based switch with multiple line cards in NetBox, the chassis would be created (from a device type) as a device, and each of its line cards would be instantiated from a module type as a module installed in one of the device's module bays.
-
-!!! tip "Device Bays vs. Module Bays"
-    What's the difference between device bays and module bays? Device bays are appropriate when the installed hardware has its own management plane, isolated from the parent device. A common example is a blade server chassis in which the blades share power but operate independently. In contrast, a module bay holds a module which does _not_ operate independently of its parent device, as with the chassis switch line card example mentioned above.
-
-One especially nice feature of modules is that templated components can be automatically renamed according to the module bay into which the parent module is installed. For example, if we create a module type with interfaces named `Gi{module}/0/1-48` and install a module of this type into module bay 7 of a device, NetBox will create interfaces named `Gi7/0/1-48`.
-
-## Cables
-
-NetBox models cables as connections among certain types of device components and other objects. Each cable can be assigned a type, color, length, and label. NetBox will enforce basic sanity checks to prevent invalid connections. (For example, a network interface cannot be connected to a power outlet.)
-
-Either end of a cable may terminate to multiple objects of the same type. For example, a network interface can be connected via a fiber optic cable to two discrete ports on a patch panel (each port attaching to an individual fiber strand in the patch cable).
-
-```mermaid
-flowchart LR
-    Interface --> Cable
-    Cable --> fp1[Front Port] & fp2[Front Port]
-```

docs/features/facilities.md

@@ -1,66 +0,0 @@
-# Facilities
-
-From global regions down to individual equipment racks, NetBox allows you to model your network's entire presence. This is accomplished through the use of several purpose-built models. The graph below illustrates these models and their relationships.
-
-```mermaid
-flowchart TD
-    Region --> Region
-    SiteGroup --> SiteGroup
-    Region & SiteGroup --> Site
-    Site --> Location & Device
-    Location --> Location
-    Location --> Rack & Device
-    Rack --> Device
-    Site --> Rack
-    RackRole --> Rack
-
-click Device "../../models/dcim/device/"
-click Location "../../models/dcim/location/"
-click Rack "../../models/dcim/rack/"
-click RackRole "../../models/dcim/rackrole/"
-click Region "../../models/dcim/region/"
-click Site "../../models/dcim/site/"
-click SiteGroup "../../models/dcim/sitegroup/"
-```
-
-## Regions
-
-Regions represent geographic domains in which your network or its customers have a presence. These are typically used to model countries, states, and cities, although NetBox does not prescribe any precise uses and your needs may differ.
-
-Regions are self-nesting, so you can define child regions within a parent, and grandchildren within each child. For example, you might create a hierarchy like this:
-
-* Europe
-    * France
-    * Germany
-    * Spain
-* North America
-    * Canada
-    * United States
-        * California
-        * New York
-        * Texas
-
-Regions will always be listed alphabetically by name within each parent, and there is no maximum depth for the hierarchy.
-
-## Site Groups
-
-Like regions, site groups can be arranged in a recursive hierarchy for grouping sites. However, whereas regions are intended for geographic organization, site groups may be used for functional grouping. For example, you might classify sites as corporate, branch, or customer sites in addition to where they are physically located.
-
-The use of both regions and site groups affords to independent but complementary dimensions across which sites can be organized.
-
-## Sites
-
-A site typically represents a building within a region and/or site group. Each site is assigned an operational status (e.g. active or planned), and can have a discrete mailing address and GPS coordinates assigned to it.
-
-## Locations
-
-A location can be any logical subdivision within a building, such as a floor or room. Like regions and site groups, locations can be nested into a self-recursive hierarchy for maximum flexibility. And like sites, each location has an operational status assigned to it.
-
-## Racks
-
-Finally, NetBox models each equipment rack as a discrete object within a site and location. These are physical objects into which devices are installed. Each rack can be assigned an operational status, type, facility ID, and other attributes related to inventory tracking. Each rack also must define a height (in rack units) and width, and may optionally specify its physical dimensions.
-
-Each rack must be associated to a site, but the assignment to a location within that site is optional. Users can also create custom roles to which racks can be assigned. NetBox supports tracking rack space in half-unit increments, so it's possible to mount devices at e.g. position 2.5 within a rack.
-
-!!! tip "Devices"
-    You'll notice in the diagram above that a device can be installed within a site, location, or rack. This approach affords plenty of flexibility as not all sites need to define child locations, and not all devices reside in racks.

docs/features/ipam.md

@@ -1,69 +0,0 @@
-# IP Address Management
-
-IP address management (IPAM) is one of NetBox's core features. It supports full parity for IP4 and IPv6, advanced VRF assignment, automatic hierarchy formation, and much more.
-
-## IP Hierarchy
-
-NetBox employs several object types to represent a hierarchy of IP resources:
-
-* **Aggregate** - A prefix which represents the root of an addressing hierarchy. This is typically a large swath of public or private address space allocated for use by your organization. Each aggregate is assigned to an authoritative RIR.
-* **Prefix** - A subnet defined within an aggregate. Prefixes extend the hierarchy by nesting within one another. (For example, 192.168.123.0/24 will appear within 192.168.0.0/16.) Each prefix can be assigned a functional role as well as an operational status.
-* **IP Range** - An arbitrary range of individual IP addresses within a prefix, all sharing the same mask. Ranges are commonly affiliated with DHCP scopes, but can be used for any similar purpose.
-* **IP Address** - An individual IP address along with its subnet mask, automatically arranged beneath its parent prefix.
-
-```mermaid
-flowchart TD
-    RIR --> Aggregate
-    Aggregate & Role --> Prefix
-    Prefix --> Prefix
-    Prefix --> IPRange & IPAddress
-
-click Aggregate "../../models/ipam/aggregate/"
-click IPAddress "../../models/ipam/ipaddress/"
-click IPRange "../../models/ipam/iprange/"
-click Prefix "../../models/ipam/prefix/"
-click RIR "../../models/ipam/rir/"
-click Role "../../models/ipam/role/"
-```
-
-!!! tip "Automatic Hierarchies"
-    IP objects in NetBox never need to be manually assigned to the parent objects. The construction of hierarchies is handled automatically by the application according to the inherent rules of IP addressing.
-
-An example hierarchy might look like this:
-
-* 100.64.0.0/10 (aggregate)
-    * 100.64.0.0/20 (prefix)
-    * 100.64.16.0/20 (prefix)
-        * 100.64.16.0/24 (prefix)
-            * 100.64.16.1/24 (address)
-            * 100.64.16.2/24 (address)
-            * 100.64.16.3/24 (address)
-        * 100.64.16.9/24 (prefix)
-    * 100.64.32.0/20 (prefix)
-        * 100.64.32.1/24 (address)
-        * 100.64.32.10-99/24 (range)
-
-## Utilization Stats
-
-The utilization rate for each prefix is calculated automatically depending on its status. _Container_ prefixes are those which house child prefixes; their utilization rate is determined based on how much of their available IP space is consumed by child prefixes. The utilization rate for any other type of prefix is determined by the aggregate usage of any child IP addresses and/or ranges defined.
-
-Similarly, utilization rates for aggregates is determined based on the space consumed by their child prefixes.
-
-## VRF Tracking
-
-NetBox supports the modeling of discrete virtual routing and forwarding (VRF) instances to represent multiple routing tables, including those with overlapping address space. Each type of IP object within an aggregate - prefix, IP range, and IP address - can be assigned to a particular VRF. Consequently, each VRF maintains its own isolated IP hierarchy. This makes it very easy to track overlapping IP space.
-
-VRF modeling in NetBox very closely follows what you find in real-world network configurations, with each VRF assigned a standards-compliant route distinguisher. You can even create route targets to manage the import and export of routing information among VRFs.
-
-!!! tip "Enforcing Unique IP Space"
-    Each VRF can be independently configured to permit or prohibit duplicate IP objects. For example, a VRF which has been configured to enforce unique IP space will not allow the creation of two 192.0.2.0/24 prefixes. The ability to toggle this restriction per VRF affords the user maximum flexibility in modeling their IP space.
-
-## AS Numbers
-
-An often overlooked component of IPAM, NetBox also tracks autonomous system (AS) numbers and their assignment to sites. Both 16- and 32-bit AS numbers are supported, and like aggregates each ASN is assigned to an authoritative RIR.
-
-## Service Mapping
-
-NetBox models network applications as discrete service objects associated with devices and/or virtual machines, and optionally with specific IP addresses attached to those parent objects. These can be used to catalog the applications running on your network for reference by other objects or integrated tools.
-
-To model services in NetBox, begin by creating a service template defining the name, protocol, and port number(s) on which the service listens. This template can then be easily instantiated to "attach" new services to a device or virtual machine. It's also possible to create new services by hand, without a template, however this approach can be tedious.

docs/features/journaling.md

@@ -1,5 +0,0 @@
-# Journaling
-
-All primary objects in NetBox support journaling. A journal is a collection of human-generated notes and comments about an object maintained for historical context. It supplements NetBox's change log to provide additional information about why changes have been made or to convey events which occur outside NetBox. Unlike the change log, in which records typically expire after a configurable period of time, journal entries persist for the life of their associated object.
-
-Each journal entry has a selectable kind (info, success, warning, or danger) and a user-populated `comments` field. Each entry automatically records the date, time, and associated user upon being created.

docs/features/l2vpn-overlay.md

@@ -1,5 +0,0 @@
-# L2VPN & Overlay
-
-L2VPN and overlay networks, such as VXLAN and EVPN, can be defined in NetBox and tied to interfaces and VLANs. This allows for easy tracking of overlay assets and their relationships with underlay resources.
-
-Each L2VPN instance has a type and optional unique identifier. Like VRFs, L2VPNs can also have import and export route targets assigned to them. Terminations can then be created to assign VLANs and/or device and virtual machine interfaces to the overlay.

docs/features/power-tracking.md

@@ -1,20 +0,0 @@
-# Power Tracking
-
-As part of its DCIM feature set, NetBox supports modeling facility power as discrete power panels and feeds. These are most commonly used to document power distribution within a data center, but can serve more traditional environments as well.
-
-![Power distribution model](../media/power_distribution.png)
-
-## Power Panels
-
-A power panel is the furthest upstream power element modeled in NetBox. It typically represents a power distribution panel (or breaker panel) where facility power is split into multiple discrete circuits, which are modeled as feeds.
-
-Each power panel is associated with a site, and may optionally be associated with a particular location within that site. There is no limit to how many power feeds a single panel can supply, however both of these object types should map to real-world objects.
-
-## Power Feeds
-
-A power feed represents a discrete power circuit originating from an upstream power panel. Each power feed can be assigned a name, operational status, and various electrical characteristics such as supply (AC or DC), voltage, amperage, and so on.
-
-A device power port can be connected to a power feed via a cable. Only one port can be connected to a feed: Where multiple devices draw power from the same feed, a power distribution unit (PDU) must be modeled as an individual device mapping a power port to multiple power outlets to which the downstream devices can connect (as in the example above).
-
-!!! tip "Primary and Redundant Power"
-    Each power feed in NetBox is assigned a type: primary or redundant. This allows easily modeling redundant power distribution topologies. In scenarios involving only a single, non-redundant power supply, mark all power feeds as primary.

docs/features/tenancy.md

@@ -1,38 +0,0 @@
-# Tenancy
-
-Most core objects within NetBox's data model support _tenancy_. This is the association of an object with a particular tenant to convey ownership or dependency. For example, an enterprise might represent its internal business units as tenants, whereas a managed services provider might create a tenant in NetBox to represent each of its customers.
-
-```mermaid
-flowchart TD
-    TenantGroup --> TenantGroup & Tenant
-    Tenant --> Site & Device & Prefix & Circuit & ...
-
-click Tenant "../../models/tenancy/tenant/"
-click TenantGroup "../../models/tenancy/tenantgroup/"
-```
-
-## Tenant Groups
-
-Tenants can be grouped by any logic that your use case demands, and groups can be nested recursively for maximum flexibility. For example, You might define a parent "Customers" group with child groups "Current" and "Past" within it. A tenant can be assigned to a group at any level within the hierarchy.
-
-## Tenants
-
-Typically, the tenant model is used to represent a customer or internal organization, however it can be used for whatever purpose meets your needs.
-
-Most core objects within NetBox can be assigned to particular tenant, so this model provides a very convenient way to correlate ownership across object types. For example, each of your customers might have its own racks, devices, IP addresses, circuits and so on: These can all be easily tracked via tenant assignment.
-
-The following objects can be assigned to tenants:
-
-* Sites
-* Racks
-* Rack reservations
-* Devices
-* VRFs
-* Prefixes
-* IP addresses
-* VLANs
-* Circuits
-* Clusters
-* Virtual machines
-
-Tenant assignment is used to signify the ownership of an object in NetBox. As such, each object may only be owned by a single tenant. For example, if you have a firewall dedicated to a particular customer, you would assign it to the tenant which represents that customer. However, if the firewall serves multiple customers, it doesn't *belong* to any particular customer, so tenant assignment would not be appropriate.

docs/features/virtualization.md

@@ -1,26 +0,0 @@
-# Virtualization
-
-Virtual machines and clusters can be modeled in NetBox alongside physical infrastructure. IP addresses and other resources are assigned to these objects just like physical objects, providing a seamless integration between physical and virtual networks.
-
-```mermaid
-flowchart TD
-    ClusterGroup & ClusterType --> Cluster
-    Cluster --> VirtualMachine
-    Platform --> VirtualMachine
-    VirtualMachine --> VMInterface
-
-click Cluster "../../models/virtualization/cluster/"
-click ClusterGroup "../../models/virtualization/clustergroup/"
-click ClusterType "../../models/virtualization/clustertype/"
-click Platform "../../models/dcim/platform/"
-click VirtualMachine "../../models/virtualization/virtualmachine/"
-click VMInterface "../../models/virtualization/vminterface/"
-```
-
-## Clusters
-
-A cluster is one or more physical host devices on which virtual machines can run. Each cluster must have a type and operational status, and may be assigned to a group. (Both types and groups are user-defined.) Each cluster may designate one or more devices as hosts, however this is optional.
-
-## Virtual Machines
-
-A virtual machine is a virtualized compute instance. These behave in NetBox very similarly to device objects, but without any physical attributes. For example, a VM may have interfaces assigned to it with IP addresses and VLANs, however its interfaces cannot be connected via cables (because they are virtual). Each VM may also define its compute, memory, and storage resources as well.

docs/features/vlan-management.md

@@ -1,24 +0,0 @@
-# VLAN Management
-
-Complementing its IPAM capabilities, NetBox also tracks VLAN information to assist with layer two network configurations. VLANs are defined per IEEE 802.1Q and related standards, and can be assigned to groups and functional roles.
-
-```mermaid
-flowchart TD
-    VLANGroup & Role --> VLAN
-
-click Role "../../models/ipam/role/"
-click VLAN "../../models/ipam/vlan/"
-click VLANGroup "../../models/ipam/vlangroup/"
-```
-
-## VLAN Groups
-
-A VLAN group is a collection of VLANs defined within a particular scope. Each VLAN group can be associated with a particular site, location, rack, or similar object to indicate its domain, and designates a minimum and maximum VLAN ID within the group. (By default, these are the standard minimum and maximum values of 1 and 4094, respectively.)
-
-Within a group, each VLAN must have a unique ID and name. There is no limit to how many groups can be created per scope.
-
-## VLANs
-
-NetBox models VLANs according to their definition under IEEE 802.1Q, with a 12-bit VLAN ID and a name. Each VLAN also has an operational status, and may be assigned a function role, just like prefixes. Each VLAN can be assigned to a VLAN group or site to convey the domain in which the VLAN exists.
-
-Once defined, VLANs can be associated with device and virtual machine interfaces. Each interface can be assigned an 802.1Q mode (access or tagged), and the relevant VLANs can be applied as tagged or untagged.

docs/features/wireless.md

@@ -1,29 +0,0 @@
-# Wireless
-
-Just as NetBox provides robust modeling for physical cable plants, it also supports modeling wireless LANs and point-to-point links.
-
-## Wireless LANs
-
-```mermaid
-flowchart TD
-    WirelessLANGroup --> WirelessLANGroup & WirelessLAN
-
-click WirelessLAN "../../models/wireless/wirelesslan/"
-click WirelessLANGroup "../../models/wireless/wirelesslangroup/"
-```
-
-A wireless LAN is a multi-access network shared by multiple wireless clients, identified by a common service set identifier (SSID) and authentication parameters. Wireless LANs can be organized into self-nesting groups, and each wireless LAN may optionally be bound to a particular VLAN. This allows easily mapping wireless networks to their wired counterparts.
-
-Authentication attributes for wireless LANs include:
-
-* **Type** - Open, WEP, WPA, etc.
-* **Cipher** - Auto, TKIP, or AES
-* **Pre-shared key (PSK)** - The secret key configured on all participating clients
-
-The definition of authentication parameters is optional.
-
-## Wireless Links
-
-Whereas a wireless LAN represents a physical multi-access segment with any number of clients, a wireless link is a point-to-point connection between exactly two stations. These links behave much like cables, but more accurately model the nature of wireless communications.
-
-Like wireless LANs, wireless links also have an SSID and (optional) authentication attributes.

docs/getting-started/planning.md

@@ -1,180 +0,0 @@
-# Planning Your Move
-
-This guide outlines the steps necessary for planning a successful migration to NetBox. Although it is written under the context of a completely new installation, the general approach outlined here works just as well for adding new data to existing NetBox deployments.
-
-## Identify Current Sources of Truth
-
-Before beginning to use NetBox for your own data, it's crucial to first understand where your existing sources of truth reside. A "source of truth" is really just any repository of data that is authoritative for a given domain. For example, you may have a spreadsheet which tracks all IP prefixes in use on your network. So long as everyone involved agrees that this spreadsheet is _authoritative_ for the entire network, it is your source of truth for IP prefixes.
-
-Anything can be a source of truth, provided it meets two conditions:
-
-1. It is agreed upon by all relevant parties that this source of data is correct.
-2. The domain to which it applies is well-defined.
-
-<!-- TODO: Example SoT -->
-
-Dedicate some time to take stock of your own sources of truth for your infrastructure. Upon attempting to catalog these, you're very likely to encounter some challenges, such as:
-
-* **Multiple conflicting sources** for a given domain. For example, there may be multiple versions of a spreadsheet circulating, each of which asserts a conflicting set of data.
-* **Sources with no domain defined.** You may encounter that different teams within your organization use different tools for the same purpose, with no normal definition of when either should be used.
-* **Inaccessible data formatting.** Some tools are better suited for programmatic usage than others. For example, spreadsheets are generally very easy to parse and export, however free-form notes on wiki or similar application are much more difficult to consume.
-* **There is no source of truth.** Sometimes you'll find that a source of truth simply doesn't exist for a domain. For example, when assigning IP addresses, operators may be just using any (presumed) available IP from a subnet without ever recording its usage.
-
-See if you can identify each domain of infrastructure data for your organization, and the source of truth for each. Once you have these compiled, you'll need to determine what belongs in NetBox.
-
-## Determine What to Move
-
-The general rule when determining what data to put into NetBox is this: If there's a model for it, it belongs in NetBox. For instance, NetBox has purpose-built models for racks, devices, cables, IP prefixes, VLANs, and so on. These are very straightforward to use. However, you'll inevitably reach the limits of NetBox's data model and question what additional data might make sense to record in NetBox. For example, you might wonder whether NetBox should function as the source of truth for infrastructure DNS records or DHCP scopes.
-
-NetBox provides two core mechanisms for extending its data model. The first is custom fields: Most models in NetBox support the addition of custom fields to hold additional data for which a built-in field does not exist. For example, you might wish to add an "inventory ID" field to the device model. The second mechanism is plugins. Users can create their own plugins to introduce entirely new models, views, and API endpoints in NetBox. This can be incredibly powerful, as it enables rapid development and tight integration with core models.
-
-That said, it doesn't always make sense to migrate a domain of data to NetBox. For example, many organizations opt to use only the IPAM components or only the DCIM components of NetBox, and integrate with other sources of truth for different domains. This is an entirely valid approach (so long as everyone involved agrees which tool is authoritative for each domain). Ultimately, you'll need to weigh the value of having non-native data models in NetBox against the effort required to define and maintain those models.
-
-Consider also that NetBox is under constant development. Although the current release might not support a particular type of object, there may be plans to add support for it in a future release. (And if there aren't, consider submitting a feature request citing your use case.)
-
-## Validate Existing Data
-
-The last step before migrating data to NetBox is the most crucial: **validation**. The GIGO (garbage in, garbage out) principle is in full effect: Your source of truth is only as good as the data it holds. While NetBox has very powerful data validation tools (including support for custom validation rules), ultimately the onus falls to a human operator to assert what is correct and what is not. For example, NetBox can validate the connection of a cable between two interfaces, but it cannot say whether the cable _should_ be there.
-
-Here are some tips to help ensure you're only importing valid data into NetBox:
-
-* Ensure you're starting with complete, well-formatted data. JSON or CSV is highly recommended for the best portability.
-* Consider defining custom validation rules in NetBox prior to import. (For example, to enforce device naming schemes.)
-* Use custom scripts to automatically populate patterned data. (For example, to automatically create a set of standard VLANs for each site.)
-
-There are several methods available to import data into NetBox, which we'll cover in the next section.
-
-## Order of Operations
-
-When starting with a completely empty database, it might not be immediately clear where to begin. Many models in NetBox rely on the advance creation of other types. For example, you cannot create a device type until after you have created its manufacturer.
-
-Below is the (rough) recommended order in which NetBox objects should be created or imported. While it is not required to follow this exact order, doing so will help ensure the smoothest workflow.
-
-1. Tenant groups and tenants
-2. Regions, site groups, sites, and locations
-3. Rack roles and racks
-4. Manufacturers, device types, and module types
-5. Platforms and device roles
-6. Devices and modules
-7. Providers and provider networks
-8. Circuit types and circuits
-9. Wireless LAN groups and wireless LANs
-10. Route targets and VRFs
-11. RIRs and aggregates
-12. IP/VLAN roles
-13. Prefixes, IP ranges, and IP addresses
-14. VLAN groups and VLANs
-15. Cluster types, cluster groups, and clusters
-16. Virtual machines and VM interfaces
-
-This is not a comprehensive list, but should suffice for the initial data imports. Beyond these, it the order in which objects are added doesn't have much if any impact.
-
-The graphs below illustrate some of the core dependencies among different models in NetBox for your reference.
-
-!!! note "Self-Nesting Models"
-    Each model in the graphs below which show a looping arrow pointing back to itself can be nested in a recursive hierarchy. For example, you can have regions representing both countries and cities, with the latter nested underneath the former.
-
-### Tenancy
-
-```mermaid
-flowchart TD
-    TenantGroup --> TenantGroup & Tenant
-    Tenant --> Site & Device & Prefix & VLAN & ...
-
-click Device "../../models/dcim/device/"
-click Prefix "../../models/ipam/prefix/"
-click Site "../../models/dcim/site/"
-click Tenant "../../models/tenancy/tenant/"
-click TenantGroup "../../models/tenancy/tenantgroup/"
-click VLAN "../../models/ipam/vlan/"
-```
-
-### Sites, Racks, and Devices
-
-```mermaid
-flowchart TD
-    Region --> Region
-    SiteGroup --> SiteGroup
-    DeviceRole & Platform --> Device
-    Region & SiteGroup --> Site
-    Site --> Location & Device
-    Location --> Location
-    Location --> Rack & Device
-    Rack --> Device
-    Manufacturer --> DeviceType & ModuleType
-    DeviceType  --> Device
-    Device & ModuleType ---> Module
-    Device & Module --> Interface
-
-click Device "../../models/dcim/device/"
-click DeviceRole "../../models/dcim/devicerole/"
-click DeviceType "../../models/dcim/devicetype/"
-click Interface "../../models/dcim/interface/"
-click Location "../../models/dcim/location/"
-click Manufacturer "../../models/dcim/manufacturer/"
-click Module "../../models/dcim/module/"
-click ModuleType "../../models/dcim/moduletype/"
-click Platform "../../models/dcim/platform/"
-click Rack "../../models/dcim/rack/"
-click RackRole "../../models/dcim/rackrole/"
-click Region "../../models/dcim/region/"
-click Site "../../models/dcim/site/"
-click SiteGroup "../../models/dcim/sitegroup/"
-```
-
-### VRFs, Prefixes, IP Addresses, and VLANs
-
-```mermaid
-flowchart TD
-    VLANGroup --> VLAN
-    Role --> VLAN & IPRange & Prefix
-    RIR --> Aggregate
-    RouteTarget --> VRF
-    Aggregate & VRF --> Prefix
-    VRF --> IPRange & IPAddress
-    Prefix --> VLAN & IPRange & IPAddress
-
-click Aggregate "../../models/ipam/aggregate/"
-click IPAddress "../../models/ipam/ipaddress/"
-click IPRange "../../models/ipam/iprange/"
-click Prefix "../../models/ipam/prefix/"
-click RIR "../../models/ipam/rir/"
-click Role "../../models/ipam/role/"
-click VLAN "../../models/ipam/vlan/"
-click VLANGroup "../../models/ipam/vlangroup/"
-click VRF "../../models/ipam/vrf/"
-```
-
-### Circuits
-
-```mermaid
-flowchart TD
-    Provider & CircuitType --> Circuit
-    Provider --> ProviderNetwork
-    Circuit --> CircuitTermination
-
-click Circuit "../../models/circuits/circuit/"
-click CircuitTermination "../../models/circuits/circuittermination/"
-click CircuitType "../../models/circuits/circuittype/"
-click Provider "../../models/circuits/provider/"
-click ProviderNetwork "../../models/circuits/providernetwork/"
-```
-
-### Clusters and Virtual Machines
-
-```mermaid
-flowchart TD
-    ClusterGroup & ClusterType --> Cluster
-    Cluster --> VirtualMachine
-    Site --> Cluster & VirtualMachine
-    Device & Platform --> VirtualMachine
-    VirtualMachine --> VMInterface
-
-click Cluster "../../models/virtualization/cluster/"
-click ClusterGroup "../../models/virtualization/clustergroup/"
-click ClusterType "../../models/virtualization/clustertype/"
-click Device "../../models/dcim/device/"
-click Platform "../../models/dcim/platform/"
-click VirtualMachine "../../models/virtualization/virtualmachine/"
-click VMInterface "../../models/virtualization/vminterface/"
-```

docs/getting-started/populating-data.md

@@ -1,42 +0,0 @@
-# Populating Data
-
-This section covers the mechanisms which are available to populate data in NetBox.
-
-## Manual Object Creation
-
-The simplest and most direct way of populating data in NetBox is to use the object creation forms in the user interface.
-
-!!! warning "Not Ideal for Large Imports"
-    While convenient and readily accessible to even novice users, creating objects one at a time by manually completing these forms obviously does not scale well. For large imports, you're generally best served by using one of the other methods discussed in this section.
-
-To create a new object in NetBox, find the object type in the navigation menu and click the green "Add" button.
-
-!!! info "Missing Button?"
-    If you don't see an "add" button for certain object types, it's likely that your account does not have sufficient permission to create these types. Ask your NetBox administrator to grant the required permissions.
-    
-    Also note that some object types, such as device components, cannot be created directly from the navigation menu. These must be created within the context of a parent object (such as a parent device).
-
-<!-- TODO: Screenshot -->
-
-## Bulk Import (CSV/YAML)
-
-NetBox supports the bulk import of new objects using CSV-formatted data. This method can be ideal for importing spreadsheet data, which is very easy to convert to CSV data. CSV data can be imported either as raw text using the form field, or by uploading a properly formatted CSV file.
-
-When viewing the CSV import form for an object type, you'll notice that the headers for the required columns have been pre-populated. Each form has a table beneath it titled "CSV Field Options," which lists _all_ supported columns for your reference. (Generally, these map to the fields you see in the corresponding creation form for individual objects.)
-
-<!-- TODO: Screenshot -->
-
-Note that some models (namely device types and module types) do not support CSV import. Instead, they accept YAML-formatted data to facilitate the import of both the parent object as well as child components.
-
-## Scripting
-
-Sometimes you'll find that data you need to populate in NetBox can be easily reduced to a pattern. For example, suppose you have one hundred branch sites and each site gets five VLANs, numbered 101 through 105. While it's certainly possible to explicitly define each of these 500 VLANs in a CSV file for import, it may be quicker to draft a simple custom script to automatically create these VLANs according to the pattern. This ensures a high degree of confidence in the validity of the data, since it's impossible for a script to "miss" a VLAN here or there.
-
-!!! tip "Reconstruct Existing Data with Scripts"
-    Sometimes, you might want to write a script to populate objects even if you have the necessary data ready for import. This is because using a script eliminates the need to manually verify existing data prior to import.
-
-## REST API
-
-You can also use the REST API to facilitate the population of data in NetBox. The REST API offers full programmatic control over the creation of objects, subject to the same validation rules enforced by the UI forms. Additionally, the REST API supports the bulk creation of multiple objects using a single request.
-
-For more information about this option, see the [REST API documentation](../integrations/rest-api.md).

docs/index.md

@@ -1,55 +1,53 @@
-![NetBox](netbox_logo.svg "NetBox logo"){style="height: 100px; margin-bottom: 3em"}
+# What is NetBox?
 
-# The Premiere Network Source of Truth
+NetBox is an open source web application designed to help manage and document computer networks. Initially conceived by the network engineering team at [DigitalOcean](https://www.digitalocean.com/), NetBox was developed specifically to address the needs of network and infrastructure engineers. It encompasses the following aspects of network management:
 
-NetBox is the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and datacenter infrastructure management (DCIM) with powerful APIs and extensions, NetBox provides the ideal "source of truth" to power network automation. Read on to discover why thousands of organizations worldwide put NetBox at the heart of their infrastructure.
+* **IP address management (IPAM)** - IP networks and addresses, VRFs, and VLANs
+* **Equipment racks** - Organized by group and site
+* **Devices** - Types of devices and where they are installed
+* **Connections** - Network, console, and power connections among devices
+* **Data circuits** - Long-haul communications circuits and providers
+* **Secrets** - Encrypted storage of sensitive credentials
 
-[![NetBox UI](./media/screenshots/netbox-ui.png)](./media/screenshots/netbox-ui.png)
+# What NetBox Isn't
 
-## :material-server-network: Built for Networks
+While NetBox strives to cover many areas of network management, the scope of its feature set is necessarily limited. This ensures that development focuses on core functionality and that scope creep is reasonably contained. To that end, it might help to provide some examples of functionality that NetBox **does not** provide:
 
-Unlike general-purpose CMDBs, NetBox has curated a data model which caters specifically to the needs of network engineers and operators. It delivers a wide assortment of object types carefully crafted to best serve the needs of infrastructure design and documentation. These cover all facets of network technology, from IP address managements to cabling to overlays and more:
+* Network monitoring
+* DNS server
+* RADIUS server
+* Configuration management
+* Facilities management
 
-* Hierarchical regions, sites, and locations
-* Racks, devices, and device components
-* Cables and wireless connections
-* Power distribution tracking
-* Data circuits and providers
-* Virtual machines and clusters
-* IP prefixes, ranges, and addresses
-* VRFs and route targets
-* FHRP groups (VRRP, HSRP, etc.)
-* AS numbers
-* VLANs and scoped VLAN groups
-* L2VPN overlays
-* Tenancy assignments
-* Contact management
+That said, NetBox _can_ be used to great effect in populating external tools with the data they need to perform these functions.
 
-## :material-hammer-wrench: Customizable & Extensible
+# Design Philosophy
 
-In addition to its expansive and robust data model, NetBox offers myriad mechanisms through which it can be customized and extended. Its powerful plugins architecture enables users to extend the application to meet their needs with minimal development effort.
+NetBox was designed with the following tenets foremost in mind.
 
-* Custom fields
-* Custom model validation
-* Export templates
-* Webhooks
-* Plugins
-* REST & GraphQL APIs
+## Replicate the Real World
 
-## :material-lock-open: Always Open
+Careful consideration has been given to the data model to ensure that it can accurately reflect a real-world network. For instance, IP addresses are assigned not to devices, but to specific interfaces attached to a device, and an interface may have multiple IP addresses assigned to it.
 
-Because NetBox is an open source application licensed under [Apache 2](https://www.apache.org/licenses/LICENSE-2.0.html), its entire code base is completely accessible to the end user, and there's never a risk of vendor lock-in. Additionally, NetBox development is an entirely public, community-driven process to which everyone can provide input.
+## Serve as a "Source of Truth"
 
-!!! tip "NetBox Development"
-    Interested in contributing to NetBox? Check out our [GitHub repository](https://github.com/netbox-community/netbox) to get started!
+NetBox intends to represent the _desired_ state of a network versus its _operational_ state. As such, automated import of live network state is strongly discouraged. All data created in NetBox should first be vetted by a human to ensure its integrity. NetBox can then be used to populate monitoring and provisioning systems with a high degree of confidence.
 
-## :material-language-python: Powered by Python
+## Keep it Simple
 
-NetBox is built on the enormously popular [Django](http://www.djangoproject.com/) framework for the Python programming language, already a favorite among network engineers. Users can leverage their existing skills coding Python tools to extend NetBox's already vast functionality via custom scripts and plugins.
+When given a choice between a relatively simple [80% solution](https://en.wikipedia.org/wiki/Pareto_principle) and a much more complex complete solution, the former will typically be favored. This ensures a lean codebase with a low learning curve.
 
-## :material-flag: Getting Started
+# Application Stack
 
-* Try out our [public demo](https://demo.netbox.dev/) if you want to jump right in
-* The [installation guide](./installation/index.md) will help you get your own deployment up and running
-* Or try the community [Docker image](https://github.com/netbox-community/netbox-docker) for a low-touch approach
-* [NetBox Cloud](https://www.getnetbox.io/) is a hosted solution offered by NS1
+NetBox is built on the [Django](https://djangoproject.com/) Python framework and utilizes a [PostgreSQL](https://www.postgresql.org/) database. It runs as a WSGI service behind your choice of HTTP server.
+
+| Function     | Component         |
+|--------------|-------------------|
+| HTTP Service | nginx or Apache   |
+| WSGI Service | gunicorn or uWSGI |
+| Application  | Django/Python     |
+| Database     | PostgreSQL        |
+
+# Getting Started
+
+See the [installation guide](installation/postgresql.md) for help getting NetBox up and running quickly.

docs/installation/1-postgresql.md

@@ -1,82 +0,0 @@
-# PostgreSQL Database Installation
-
-This section entails the installation and configuration of a local PostgreSQL database. If you already have a PostgreSQL database service in place, skip to [the next section](2-redis.md).
-
-!!! warning "PostgreSQL 10 or later required"
-    NetBox requires PostgreSQL 10 or later. Please note that MySQL and other relational databases are **not** supported.
-
-## Installation
-
-=== "Ubuntu"
-
-    ```no-highlight
-    sudo apt update
-    sudo apt install -y postgresql
-    ```
-
-=== "CentOS"
-
-    ```no-highlight
-    sudo yum install -y postgresql-server
-    sudo postgresql-setup --initdb
-    ```
-
-    CentOS configures ident host-based authentication for PostgreSQL by default. Because NetBox will need to authenticate using a username and password, modify `/var/lib/pgsql/data/pg_hba.conf` to support MD5 authentication by changing `ident` to `md5` for the lines below:
-
-    ```no-highlight
-    host    all             all             127.0.0.1/32            md5
-    host    all             all             ::1/128                 md5
-    ```
-
-Once PostgreSQL has been installed, start the service and enable it to run at boot:
-
-```no-highlight
-sudo systemctl start postgresql
-sudo systemctl enable postgresql
-```
-
-Before continuing, verify that you have installed PostgreSQL 10 or later:
-
-```no-highlight
-psql -V
-```
-
-## Database Creation
-
-At a minimum, we need to create a database for NetBox and assign it a username and password for authentication. Start by invoking the PostgreSQL shell as the system Postgres user.
-
-```no-highlight
-sudo -u postgres psql
-```
-
-Within the shell, enter the following commands to create the database and user (role), substituting your own value for the password:
-
-```postgresql
-CREATE DATABASE netbox;
-CREATE USER netbox WITH PASSWORD 'J5brHrAXFLQSif0K';
-GRANT ALL PRIVILEGES ON DATABASE netbox TO netbox;
-```
-
-!!! danger "Use a strong password"
-    **Do not use the password from the example.** Choose a strong, random password to ensure secure database authentication for your NetBox installation.
-
-Once complete, enter `\q` to exit the PostgreSQL shell.
-
-## Verify Service Status
-
-You can verify that authentication works by executing the `psql` command and passing the configured username and password. (Replace `localhost` with your database server if using a remote database.)
-
-```no-highlight
-$ psql --username netbox --password --host localhost netbox
-Password for user netbox: 
-psql (12.5 (Ubuntu 12.5-0ubuntu0.20.04.1))
-SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off)
-Type "help" for help.
-
-netbox=> \conninfo
-You are connected to database "netbox" as user "netbox" on host "localhost" (address "127.0.0.1") at port "5432".
-SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off)
-netbox=> \q
-```
-
-If successful, you will enter a `netbox` prompt. Type `\conninfo` to confirm your connection, or type `\q` to exit.