From 66d8c27b1e29adbe140128a39abd326de109325c Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Thu, 30 Jun 2016 13:02:06 -0400 Subject: [PATCH 1/2] standardized app installation commands * 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. --- docs/getting-started.md | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 2da4676cb..59bb341be 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -15,7 +15,7 @@ The following packages are needed to install PostgreSQL: * python-psycopg2 ``` -# apt-get install postgresql libpq-dev python-psycopg2 +# sudo apt-get install -y postgresql libpq-dev python-psycopg2 ``` ## Configuration @@ -61,7 +61,7 @@ NetBox requires following dependencies: * 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. @@ -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: ``` -# 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: @@ -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.) ``` -# pip install -r requirements.txt +# sudo pip install -r requirements.txt ``` ## 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. ``` -# apt-get install gunicorn supervisor +# sudo apt-get install -y gunicorn supervisor apache2 nginx ``` ## nginx Configuration 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 { 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. ``` -# sudo apt-get -y bc +# sudo apt-get install -y bc ``` Next we'll clone Let's Encrypt into /opt/: From a165445808decda4ddc5c7607196b593f9a50e03 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Thu, 30 Jun 2016 13:11:43 -0400 Subject: [PATCH 2/2] Update getting-started.md --- docs/getting-started.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 59bb341be..08eb07e04 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -235,13 +235,19 @@ 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. ``` -# sudo apt-get install -y gunicorn supervisor apache2 nginx +# sudo apt-get install -y gunicorn supervisor ``` ## nginx Configuration The following will serve as a minimal nginx configuration. Be sure to modify your server name and installation path appropriately. +``` +# sudo apt-get install -y nginx +``` + +Once nginx is installed, proceed with the following configuration: + ``` server { listen 80; @@ -280,7 +286,11 @@ Restart the nginx service to use the new configuration. ``` ## Apache Configuration -The following configuration should work for Apache. Be sure to modify the `ServerName` appropriately. +``` +# sudo apt-get install -y apache2 +``` + +Once Apache is installed, proceed with the following configuration (Be sure to modify the `ServerName` appropriately): ```