1
0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00

Reset documentation hierarchy

This commit is contained in:
Jeremy Stretch
2020-03-05 17:23:56 -05:00
parent f89773f4a3
commit a7c133daa6
21 changed files with 110 additions and 76 deletions

View File

@@ -1,3 +1,5 @@
# 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

View File

@@ -1,12 +1,16 @@
# Redis Installation
## Install Redis
[Redis](https://redis.io/) is an in-memory key-value store which NetBox employs for caching and queuing. This section entails the installation and configuration of a local Redis instance. If you already have a Redis service in place, skip to [the next section](3-netbox.md).
#### Ubuntu
### Ubuntu
```no-highlight
# apt-get install -y redis-server
```
#### CentOS
### CentOS
```no-highlight
# yum install -y epel-release

View File

@@ -1,14 +1,16 @@
# NetBox Installation
This section of the documentation discusses installing and configuring the NetBox application. Begin by installing all system packages required by NetBox and its dependencies:
## Install System Packages
#### Ubuntu
### Ubuntu
```no-highlight
# apt-get install -y python3 python3-pip python3-venv python3-dev build-essential libxml2-dev libxslt1-dev libffi-dev libpq-dev libssl-dev zlib1g-dev
```
#### CentOS
### CentOS
```no-highlight
# yum install -y gcc python36 python36-devel python36-setuptools libxml2-devel libxslt-devel libffi-devel openssl-devel redhat-rpm-config
@@ -93,7 +95,7 @@ Next, activate the virtual environment and install the required Python packages.
(venv) # pip3 install -r requirements.txt
```
#### NAPALM Automation (Optional)
### NAPALM Automation (Optional)
NetBox supports integration with the [NAPALM automation](https://napalm-automation.net/) library. NAPALM allows NetBox to fetch live data from devices and return it to a requester via its REST API. Installation of NAPALM is optional. To enable it, install the `napalm` package:
@@ -101,7 +103,7 @@ NetBox supports integration with the [NAPALM automation](https://napalm-automati
(venv) # pip3 install napalm
```
#### Remote File Storage (Optional)
### Remote File Storage (Optional)
By default, NetBox will use the local filesystem to storage uploaded files. To use a remote filesystem, install the [`django-storages`](https://django-storages.readthedocs.io/en/stable/) library and configure your [desired backend](../../configuration/optional-settings/#storage_backend) in `configuration.py`.

View File

@@ -1,3 +1,5 @@
# HTTP Server Setup
We'll set up a simple WSGI front end using [gunicorn](http://gunicorn.org/) for the purposes of this guide. For web servers, we provide example configurations for both [nginx](https://www.nginx.com/resources/wiki/) and [Apache](http://httpd.apache.org/docs/2.4). (You are of course free to use whichever combination of HTTP and WSGI services you'd like.) We'll use systemd to enable service persistence.
!!! info

View File

@@ -1,8 +1,10 @@
# LDAP Configuration
This guide explains how to implement LDAP authentication using an external server. User authentication will fall back to built-in Django users in the event of a failure.
## Install Requirements
#### Install openldap-devel
### Install openldap-devel
On Ubuntu:
@@ -16,7 +18,7 @@ On CentOS:
sudo yum install -y openldap-devel
```
#### Install django-auth-ldap
### Install django-auth-ldap
```no-highlight
pip3 install django-auth-ldap
@@ -79,7 +81,7 @@ AUTH_LDAP_USER_ATTR_MAP = {
}
```
## User Groups for Permissions
### User Groups for Permissions
!!! info
When using Microsoft Active Directory, support for nested groups can be activated by using `NestedGroupOfNamesType()` instead of `GroupOfNamesType()` for `AUTH_LDAP_GROUP_TYPE`. You will also need to modify the import line to use `NestedGroupOfNamesType` instead of `GroupOfNamesType` .

View File

@@ -8,7 +8,7 @@ The following sections detail how to set up a new instance of NetBox:
4. [HTTP daemon](4-http-daemon.md)
5. [LDAP authentication](5-ldap.md) (optional)
# Upgrading
## Upgrading
If you are upgrading from an existing installation, please consult the [upgrading guide](upgrading.md).

View File

@@ -1,14 +1,16 @@
# Migrating to systemd
This document contains instructions for migrating from a legacy NetBox deployment using [supervisor](http://supervisord.org/) to a systemd-based approach.
## Ubuntu
### Uninstall supervisord:
### Uninstall supervisord
```no-highlight
# apt-get remove -y supervisord
```
### Configure systemd:
### Configure systemd
!!! note
These instructions assume the presence of a Python virtual environment at `/opt/netbox/venv`. If you have not created this environment, please refer to the [installation instructions](3-netbox.md#set-up-python-environment) for direction.

View File

@@ -1,3 +1,5 @@
# Upgrading to a New NetBox Release
## Review the Release Notes
Prior to upgrading your NetBox instance, be sure to carefully review all [release notes](../../release-notes/) that have been published since your current version was released. Although the upgrade process typically does not involve additional work, certain releases may introduce breaking or backward-incompatible changes. These are called out in the release notes under the version in which the change went into effect.
@@ -49,7 +51,7 @@ Copy the LDAP configuration if using LDAP:
# cp netbox-X.Y.Z/netbox/netbox/ldap_config.py netbox/netbox/netbox/ldap_config.py
```
### Option B: Clone the Git Repository (latest master release)
### Option B: Clone the Git Repository
This guide assumes that NetBox is installed at `/opt/netbox`. Pull down the most recent iteration of the master branch: