NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-14 01:41:22 -06:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

standardized app installation commands

Browse Source 
* Standardized all install commands to use sudo & -y to avoid new user confusion.
* Added required missing installation (apache2 missing in Web Server and gunicorn section)
* Consolidated installs for a section to follow same format (Web Server and gunicorn section nginx)
* Added missing install argument when installing the arbitrary precision calculator language.
This commit is contained in:
ryanmerolle 2016-06-30 13:02:06 -04:00 committed by GitHub
parent 85f3324d97
commit 66d8c27b1e
1 changed files with 6 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/getting-started.md
View File

@ -15,7 +15,7 @@ The following packages are needed to install PostgreSQL:
* python-psycopg2 * python-psycopg2
``` ```
# apt-get install postgresql libpq-dev python-psycopg2 # sudo apt-get install -y postgresql libpq-dev python-psycopg2
``` ```
## Configuration ## Configuration
@ -61,7 +61,7 @@ NetBox requires following dependencies:
* graphviz * graphviz
``` ```
# apt-get install python2.7 python-dev git python-pip libxml2-dev libxslt1-dev libffi-dev graphviz # sudo apt-get install -y python2.7 python-dev git python-pip libxml2-dev libxslt1-dev libffi-dev graphviz
``` ```
You may opt to install NetBox either from a numbered release or by cloning the master branch of its repository on GitHub. You may opt to install NetBox either from a numbered release or by cloning the master branch of its repository on GitHub.
@ -90,7 +90,7 @@ Create the base directory for the NetBox installation. For this guide, we'll use
If `git` is not already installed, install it: If `git` is not already installed, install it:
``` ```
# sudo apt-get install git # sudo apt-get install -y git
``` ```
Next, clone the **master** branch of the NetBox GitHub repository into the current directory: Next, clone the **master** branch of the NetBox GitHub repository into the current directory:
@ -111,7 +111,7 @@ Checking connectivity... done.
Install the necessary Python packages using pip. (If you encounter any compilation errors during this step, ensure that you've installed all of the required dependencies.) Install the necessary Python packages using pip. (If you encounter any compilation errors during this step, ensure that you've installed all of the required dependencies.)
``` ```
# pip install -r requirements.txt # sudo pip install -r requirements.txt
``` ```
## Configuration ## Configuration
@ -235,19 +235,13 @@ If the test service does not run, or you cannot reach the NetBox home page, some
We'll set up a simple HTTP 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 also use [supervisord](http://supervisord.org/) for service persistence. We'll set up a simple HTTP 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 also use [supervisord](http://supervisord.org/) for service persistence.
``` ```
# apt-get install gunicorn supervisor # sudo apt-get install -y gunicorn supervisor apache2 nginx
``` ```
## nginx Configuration ## nginx Configuration
The following will serve as a minimal nginx configuration. Be sure to modify your server name and installation path appropriately. The following will serve as a minimal nginx configuration. Be sure to modify your server name and installation path appropriately.
```
# apt-get install nginx
```
Once nginx is installed, proceed with the following configuration:
``` ```
server { server {
listen 80; listen 80;
@ -358,7 +352,7 @@ Please keep in mind that the configurations provided here are bare minimums requ
To add SSL support to the installation we'll start by installing the arbitrary precision calculator language. To add SSL support to the installation we'll start by installing the arbitrary precision calculator language.
``` ```
# sudo apt-get -y bc # sudo apt-get install -y bc
``` ```
Next we'll clone Let's Encrypt into /opt/: Next we'll clone Let's Encrypt into /opt/: