update title of ubuntu README

README.md

@@ -1,4 +1,4 @@
-# Django Setup for CentOS 7
+# Django Setup for Ubuntu 18.04
 ## Install
 ```bash
 vim vars
@@ -15,20 +15,23 @@ export gitkey=""            <-- put the path to the ssh key git will use here
 ```
 
 ```bash
-sudo ./install.sh
+sudo -s                     <-- you must be root to run script
+./install.sh
 ```
 
 ## Reset
 If anything goes wrong with the project and you don't want to perform a full uninstall:
 ```bash
-sudo ./reset
+sudo -s
+./reset
 ```
 will reset the project but leave the dependencies installed. You can rerun the installer with different variables to fix what was incorrect. WARNING: This will delete your project (including your database)
 
 ## Uninstall
 To completely remove every trace of the project from your server:
 ```bash
-sudo ./uninstall
+sudo -s
+./uninstall
 ```
 This will completely remove everything.
 
@@ -37,18 +40,15 @@ This will completely remove everything.
 ### vars
 ```bash
 # Django project settings
-user="centos"
+user=""
-projectname="mysite"
+projectname=""
-hostname="centos.duco.net"
+hostname=""
 letsencrypt=False
 
-# set True if CentOS minimal install
-install_epel_release=False
-
 # general install settings
 logdir="/var/log/djangosetup/"
-yumlogloc=$logdir"yum.log"
+aptlogloc=$logdir"apt.log"
-yumlogmsg="See $yumlogloc for more info."
+aptlogmsg="See $aptlogloc for more info."
 firelogloc=$logdir"firewall.log"
 firelogmsg="See $firelogloc for more info."
 pylogloc=$logdir"python.log"
@@ -72,15 +72,11 @@ My recommendation is to use nginx as the user. The installer takes care of creat
 
 The projectname variable can be whatever you want. When Django starts the project it will use this name.
 
-The hostname will be inserted into "ALLOWED_HOSTS" in your app settings. Multiple hosts are not supported at the moment so set this to the address you'll test with. You can add additional hosts by manually editing ```settings.py```.
+The hostname will be added as an environment variable for gunicorn.  Multiple hosts are not supported at the moment so set this to the address you'll test with. You can add additional hosts by manually editing ```settings.py```.
-
-```install_epel_release=True```
-
-If you are installing this on a system with the minimal CentOS build you'll need install_epel_release to be True. ```epel_release``` installs nginx. Kinda hard to run the site without that.
 
 ## Install
 ### Dependencies
-In order for this script to work its magic you'll need a few packages provided by Yum. This part is likely to break due to Yum's inconsistency accross distributions, firewall and proxy configurations, and whether CentOS had its morning coffee.
+In order for this script to work its magic you'll need a few packages provided by apt.
 
 ```bash
 # check if root
@@ -97,61 +93,43 @@ tput setaf 0
 if [ ! -d $logdir ] ; then
 	mkdir $logdir
 fi
-if [ $install_epel_release = True ] ; then
-    yum -y install epel-release 1>> $yumlogloc 2>> $yumlogloc 3>> $pylogloc
-fi
 ```
 
-The first part of the script is fairly straight forward. If you aren't root user, the installer can't use yum and won't work. After checking if you are the root user it creates the necessary directories to prevent future complaints and installs the aforementioned epel-release package if you want it.
+The first part of the script is fairly straight forward. If you aren't root user, the installer can't use apt and won't work. After checking if you are the root user it creates the necessary directories to prevent future complaints.
 
 ```bash
 # install dependencies
-packages=(gcc wget nginx libsqlite3x-devel.x86_64 postgresql-server postgresql-devel postgresql-contrib bzip2-devel zlib-devel libffi-devel openssl-devel policycoreutils-python.x86_64)
+packages=(gcc wget nginx ufw make sqlite3 bzip2 openssl libffi-dev libssl-dev libsqlite3-dev zlib1g-dev libbz2-dev)
 for package in ${packages[@]};
 do
     echo -e "\tInstalling $package"
-    yum -y install $package 1>> $yumlogloc 2>> $yumlogloc 3>> $yumlogloc
+    touch $aptlogloc
+    apt install -y $package 1>> $aptlogloc 2>> $aptlogloc 3>> $aptlogloc
     if [ $? -ne 0 ] ; then
-        echo -e "yum failed to install $package. $yumlogmsg"
+        echo -e "apt failed to install $package. $aptlogmsg"
         exit 1
     fi
 done
 ```
 
-The next part of the script installs yum dependencies. The script verifies that the installation goes smoothly and exits if an error occurs.
+The next part of the script installs apt dependencies. The script verifies that the installation goes smoothly and exits if an error occurs.
 
 ### Firewall
 ```bash
-# set firewall
+# firewall
-echo -e "firewall-cmd --zone=public --add-port=80/tcp --permanent" > $firelogloc
+ports=(22 80 443)
-firewall-cmd --zone=public --add-port=80/tcp --permanent >> $firelogloc
+for port in ${ports[@]};
-if [ $? -ne 0 ] ; then
+do
-	echo -e "firewall failed to update port 80 correctly (this may not be an issue). $firelogmsg"
+    echo -e "ufw allow $port/tcp" > $firelogloc
-fi
+    ufw allow $port/tcp 1>> $firelogloc 2>> $firelogloc
-
+    if [ $? -ne 0 ] ; then
-echo -e "firewall-cmd --zone=public --add-port=443/tcp --permanent" >> $firelogloc
+    	echo -e "\tfirewall failed to update port $port correctly. $firelogmsg"
-firewall-cmd --zone=public --add-port=443/tcp --permanent >> $firelogloc
-if [ $? -ne 0 ] ; then
-	echo -e "firewall failed to update port 443 correctly, (this may not be an issue). $firelogmsg"
-fi
-
-echo -e "firewall-cmd --reload" >> $firelogloc
-firewall-cmd --reload >> $firelogloc
-if [ $? -ne 0 ] ; then
-	echo -e "firewall failed to reload, (this may not be an issue). $firelogmsg"
-fi
-
-echo -e "semanage permissive -a httpd_t" >> $firelogloc
-semanage permissive -a httpd_t >> $firelogloc
-if [ $? -ne 0 ] ; then
-	echo -e "semanage failed to set permissive. See $firelogmsg"
         exit 1
-fi
+    fi
+done
 ```
 
-The firewall commands are specific to a CentOS 7 minimal install. You may not need them. The installer doesn't really care if they fail because they aren't mission critical. It'll yell at you and that's about it.
+The next part of the script opens the necessary ports through ufw.
-
-The **semanage** command fixes an issue where the websocket would be inaccessible after an install.
 
 ### Python
 ```bash
@@ -252,19 +230,19 @@ fi
 ```
 Next the script starts the Django project. You'll notice that the project structure looks like this:
 ```
+
 [projectname]/
-├──  [projectname]/
+├── [config]/
-│    ├── [projectname]/
+│   ├── __init__.py
-│    │   ├── __init__.py
+│   ├── settings.py
-│    │   ├── settings.py
+│   ├── urls.py
-│    │   ├── urls.py
+│   └── wsgi.py
-│    │   └── wsgi.py
+├── manage.py
-│    └── manage.py
 └── venv/
 ```
-When making changes to nginx or gunicorn it's important to keep this structure in mind. There are 3 folders called ```$projectname```. 
+When making changes to nginx or gunicorn it's important to keep this structure in mind.
 
-After this, the script updates allowed hosts, collects static, and makes migrations.
+After starting the Django project, the script updates allowed hosts, collects static, and makes migrations.
 
 ### Gunicorn
 ```bash
@@ -275,7 +253,7 @@ After=network.target
 
 [Service]
 User=$user
-Group=nginx
+Group=www-data
 WorkingDirectory=/home/$user/$projectname/$projectname
 ExecStart=/home/$user/$projectname/venv/bin/gunicorn --workers 3 --bind unix:/home/$user/$projectname/$projectname.sock $projectname.wsgi:application
 

install.sh

@@ -0,0 +1,290 @@
+################################################################################s
+# Dependencies
+# Installs Dependencies automatically
+################################################################################
+
+# source vars
+source vars
+
+# check if root
+if [[ $EUID -ne 0 ]]; then
+   echo -e "This script must be run as root" 
+   exit 1
+fi
+
+tput setaf 2
+echo -e "Installing dependencies"
+tput setaf 9
+# create necessary dirs
+if [ ! -d $logdir ] ; then
+	mkdir $logdir
+fi
+
+# install dependencies
+packages=(gcc wget nginx ufw make sqlite3 bzip2 openssl libffi-dev libssl-dev libsqlite3-dev zlib1g-dev libbz2-dev)
+for package in ${packages[@]};
+do
+    echo -e "\tInstalling $package"
+    apt install -y $package 1>> $aptlogloc 2>> $aptlogloc 3>> $aptlogloc
+    if [ $? -ne 0 ] ; then
+        echo -e "apt failed to install $package. $aptlogmsg"
+        exit 1
+    fi
+done
+
+# firewall
+ports=(22 80 443)
+for port in ${ports[@]};
+do
+    echo -e "ufw allow $port/tcp" > $firelogloc
+    ufw allow $port/tcp 1>> $firelogloc 2>> $firelogloc
+    if [ $? -ne 0 ] ; then
+    	echo -e "\tfirewall failed to update port $port correctly. $firelogmsg"
+        exit 1
+    fi
+done
+echo -e "\tenabling ufw"
+ufw --force enable
+
+################################################################################
+# Python
+# Download and setup Python and modules
+################################################################################
+tput setaf 2
+echo -e "Installing Python"
+tput setaf 9
+
+# fetch Python
+if [ ! -d $pyinstalldir ] ; then # if we already installed python
+    wget $pylink 1> $pylogloc 2>> $pylogloc 3>> $pylogloc
+    if [ $? -ne 0 ] ; then
+        echo -e "Failed to fetch python, make sure wget is installed and $pylink is what you're after. $pylogmsg"
+        exit 1
+    fi
+    tar xf Python-3.7.0.tar.xz 1>> $pylogloc 2>> $pylogloc 3>> $pylogloc
+    if [ $? -ne 0 ] ; then
+        echo -e "Failed to unzip python. $pylogmsg"
+        exit 1
+    fi
+    cd Python-3.7.0
+    if [ $? -ne 0 ] ; then
+        echo -e "Missing python directory. $pylogmsg"
+        exit 1
+    fi
+
+    # install Python
+    echo -e "\tConfigure"
+    ./configure --prefix $pyinstalldir 1>> $pylogloc 2>> $pylogloc 3>> $pylogloc
+    if [ $? -ne 0 ] ; then
+        echo -e "./configure failed. $pylogmsg"
+        exit 1
+    fi
+    echo -e "\tMake"
+    make 1>> $pylogloc 2>> $pylogloc 3>> $pylogloc
+    if [ $? -ne 0 ] ; then
+        echo -e "make failed. $pylogmsg"
+        exit 1
+    fi
+    echo -e "\tMake altinstall"
+    make altinstall 1>> $pylogloc 2>> $pylogloc 3>> $pylogloc
+    if [ $? -ne 0 ] ; then
+        echo -e "make altinstall failed. $pylogmsg"
+        exit 1
+    fi
+fi
+# upgrade pip and install virtualenv
+echo -e "\tUpgrading pip"
+/usr/src/python37/bin/python3.7 -m pip install --upgrade pip 1>> $pylogloc 2>> $pylogloc 3>> $pylogloc
+if [ $? -ne 0 ] ; then
+	echo -e "pip upgrade failed. $pylogmsg"
+    exit 1
+fi
+echo -e "\tInstalling virtualenv"
+/usr/src/python37/bin/python3.7 -m pip install virtualenv 1>> $pylogloc 2>> $pylogloc 3>> $pylogloc
+if [ $? -ne 0 ] ; then
+	echo -e "installing virtualenv failed. $pylogmsg"
+    exit 1
+fi
+cd /root/
+rm Python-3.7.0.tar.xz 1>> $pylogloc 2>> $pylogloc
+rm -rf Python-3.7.0 1>> $pylogloc 2>> $pylogloc
+if [ $? -ne 0 ] ; then
+	echo -e "Failed to remove Python install files. $pylogmsg"
+fi
+
+################################################################################
+# Django
+# Download, setup and configure Django
+################################################################################
+tput setaf 2
+echo -e "Starting Django project"
+tput setaf 9
+
+adduser $user 1> /dev/null 2> /dev/null 3> /dev/null
+if [ ! -d "/home/$user" ] ; then
+	mkdir /home/$user
+    chown -R $user:$user /home/$user
+fi
+mkdir /home/$user/$projectname
+if [ $? -ne 0 ] ; then
+	echo -e "Failed to create $projectname directory. $djamsg"
+    exit 1
+fi
+
+# virtual environment
+echo -e "\tCreating venv"
+cd /home/$user/$projectname
+/usr/src/python37/bin/python3.7 -m virtualenv venv 1>> $djalogloc 2>> $djalogloc 3>> $djalogloc
+if [ $? -ne 0 ] ; then
+	echo -e "Failed to create virtual environment. $djamsg"
+    exit 1
+fi
+source venv/bin/activate 1>> $djalogloc 2>> $djalogloc 3>> $djalogloc
+if [ $? -ne 0 ] ; then
+	echo -e "Failed to source virtual environment. $djamsg"
+    exit 1
+fi
+
+# pip installs
+pips=(django gunicorn psycopg2-binary)
+for pip in ${pips[@]};
+do
+    echo -e "\tInstalling $pip"
+    pip install $pip 1>> $djalogloc 2>> $djalogloc 3>> $djalogloc
+    if [ $? -ne 0 ] ; then
+    	echo -e "Failed to install $pip. $djamsg"
+      exit 1
+    fi
+done
+
+if [ $usegit = False ] ; then
+    # start django project in the project directory
+    echo -e "\tStarting django project"
+    django-admin startproject config . 1>> $djalogloc 2>> $djalogloc 3>> $djalogloc
+    if [ $? -ne 0 ] ; then
+        echo -e "Failed to start project $projectname with django-admin. $djamsg"
+        exit 1
+    fi
+
+    # update allowed hosts
+    echo -e "echo -e sed -i 's/ALLOWED_HOSTS = []/ALLOWED_HOSTS = ['localhost', os.environ.get('HOST')'] config/settings.py" >> $djalogloc
+    #        |        FROM        |                          TO                           |
+    sed -i "s/ALLOWED_HOSTS = \[\]/ALLOWED_HOSTS = \['localhost', os.environ.get('HOST')\]/" config/settings.py
+    if [ $? -ne 0 ] ; then
+        echo -e "Failed to change ALLOWED_HOSTS. $djamsg"
+        exit 1
+    fi
+    echo -e "echo -e STATIC_ROOT = os.path.join(BASE_DIR, 'static') >> config//settings.py" >> $djalogloc
+    echo -e "STATIC_ROOT = os.path.join(BASE_DIR, 'static')" >> config/settings.py
+    if [ $? -ne 0 ] ; then
+        echo -e "Failed to append STATIC_ROOT. $djamsg"
+        exit 1
+    fi
+fi
+
+if [ $usegit = True ] ; then
+    echo -e "\tCloning django project"
+    ssh-agent bash -c 'ssh-add $gitkey 1>> $gitlogloc 2>> $gitlogloc 3>> $gitlogloc;
+    git init 1>> $gitlogloc 2>> $gitlogloc 3>> $gitlogloc;
+    git remote add origin $giturl 1>> $gitlogloc 2>> $gitlogloc 3>> $gitlogloc;
+    git pull origin master 1>> $gitlogloc 2>> $gitlogloc 3>> $gitlogloc;'
+    echo -e "\tInstalling pip requirements"
+    pip install -r requirements.txt 1>> $gitlogloc 2>> $gitlogloc 3>> $gitlogloc
+fi
+
+# collect static, migrate
+echo -e "\tCollecting static"
+python manage.py collectstatic 1>> $djalogloc 2>> $djalogloc 3>> $djalogloc
+if [ $? -ne 0 ] ; then
+	echo -e "Failed to collect static files. $djamsg"
+    exit 1
+fi
+echo -e "\tMaking migrations"
+python manage.py makemigrations 1>> $djalogloc 2>> $djalogloc 3>> $djalogloc
+if [ $? -ne 0 ] ; then
+	echo -e "Failed to make migrations. $djamsg"
+    exit 1
+fi
+echo -e "\tMigrating"
+python manage.py migrate 1>> $djalogloc 2>> $djalogloc 3>> $djalogloc
+if [ $? -ne 0 ] ; then
+	echo -e "Failed to migrate. You do not survive the winter. $djamsg"
+    exit 1
+fi
+deactivate
+if [ $? -ne 0 ] ; then
+	echo -e "Failed to deactivate virtual environment, (this may not be an issue). $djamsg"
+fi
+chown -R $user:$user .
+if [ $? -ne 0 ] ; then
+	echo -e "Failed to change permissions of $projectname. $djamsg"
+    exit 1
+fi
+
+################################################################################
+# Gunicorn
+# configure gunicorn.conf file
+################################################################################
+tput setaf 2
+echo -e "Setting up gunicorn"
+tput setaf 9
+echo -e "
+[Unit]
+Description=gunicorn daemon
+After=network.target
+
+[Service]
+User=$user
+Group=www-data
+WorkingDirectory=/home/$user/$projectname
+ExecStart=/home/$user/$projectname/venv/bin/gunicorn --workers 3 --bind unix:/home/$user/$projectname/$projectname.sock config.wsgi:application
+Environment=HOST=$hostname
+
+[Install]
+WantedBy=multi-user.target" > /etc/systemd/system/gunicorn.service
+echo -e "\tStarting gunicorn"
+systemctl daemon-reload > $gunicornlogloc
+systemctl start gunicorn >> $gunicornlogloc
+systemctl status gunicorn >> $gunicornlogloc
+echo -e "\tEnabling gunicorn at startup"
+systemctl enable gunicorn 1>> $gunicornlogloc 2>> $gunicornlogloc
+
+################################################################################
+# Nginx
+# configure nginx
+################################################################################
+tput setaf 2
+echo -e "Configuring Nginx"
+tput setaf 9
+echo -e "
+server {
+    listen 80;
+    server_name $hostname;
+
+    location = /favicon.ico { access_log off; log_not_found off; }
+    location /static/ {
+        root /home/$user/$projectname;
+    }
+
+    location / {
+        proxy_set_header Host \$http_host;
+        proxy_set_header X-Real-IP \$remote_addr;
+        proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto \$scheme;
+        proxy_pass http://unix:/home/$user/$projectname/$projectname.sock;
+    }
+}" > /etc/nginx/conf.d/$projectname.conf
+# set the nginx user
+if [ ! $user = "nginx" ] ; then
+    sed -i "s/user nginx/user $user nginx/" /etc/nginx/nginx.conf
+fi
+echo -e "\tStarting nginx"
+systemctl restart nginx >> $nginxlogloc
+systemctl status nginx >> $nginxlogloc
+echo -e "\tEnabling nginx"
+systemctl enable nginx 1>> $nginxlogloc 2>> $nginxlogloc
+
+tput setaf 2
+echo -e "Done! Navigate to $hostname to access the site. Logs can be found in $logdir"
+tput setaf 9
+exit 0

reset.sh

@@ -0,0 +1,30 @@
+################################################################################
+#                          Performs a QUICK uninstall                          #
+#                       - Does not uninstall dependencies                      #
+#                          - Does not remove python                            #
+################################################################################
+
+# source vars
+source vars
+
+# remove nginx conf
+tput setaf 2
+echo "Disabling nginx"
+tput setaf 9
+systemctl stop nginx 1> /dev/null 2> /dev/null
+systemctl disable nginx 1> /dev/null 2> /dev/null
+rm -f /etc/nginx/conf.d/$projectname.conf
+
+# remove gunicorn
+tput setaf 2
+echo "Uninstalling gunicorn"
+tput setaf 9
+systemctl disable gunicorn 1> /dev/null 2> /dev/null
+systemctl stop gunicorn 1> /dev/null 2> /dev/null
+rm -f /etc/systemd/system/gunicorn.service
+
+# remove project
+tput setaf 2
+echo "Removing Django project"
+tput setaf 9
+rm -rf /home/$user/$projectname

uninstall.sh

@@ -0,0 +1,48 @@
+################################################################################
+#                           Performs a FULL uninstall                          #
+################################################################################
+
+# source vars
+source vars
+
+# remove nginx conf
+tput setaf 2
+echo "Disabling nginx"
+tput setaf 9
+systemctl stop nginx 1> /dev/null 2> /dev/null
+systemctl disable nginx 1> /dev/null 2> /dev/null
+rm -f /etc/nginx/conf.d/$projectname.conf
+
+# remove gunicorn
+tput setaf 2
+echo "Uninstalling gunicorn"
+tput setaf 9
+systemctl disable gunicorn 1> /dev/null 2> /dev/null
+systemctl stop gunicorn 1> /dev/null 2> /dev/null
+rm -f /etc/systemd/system/gunicorn.service
+
+# remove project
+tput setaf 2
+echo "Removing Django project"
+tput setaf 9
+rm -rf /home/$user/$projectname
+
+# remove python
+tput setaf 2
+echo "Uninstalling python"
+tput setaf 9
+rm -rf $pyinstalldir
+
+# remove yum dependencies
+tput setaf 2
+echo "Uninstalling dependencies"
+tput setaf 9
+packages=(gcc wget nginx ufw make sqlite3 bzip2 openssl libffi-dev libssl-dev libsqlite3-dev zlib1g-dev libbz2-dev)
+for package in ${packages[@]};
+do
+    echo -e "\tRemoving $package"
+    apt purge -y $package 1>> /dev/null 2>> /dev/null 3>> /dev/null
+    if [ $? -ne 0 ] ; then
+        echo -e "\tapt failed to remove $package."
+    fi
+done

vars

@@ -0,0 +1,26 @@
+# django project settings
+export user=""
+export projectname=""
+export hostname=""
+export usegit=False         # if you have a django git project
+export giturl=""            # url for git project
+export gitkey=""            # IdentityFile
+
+# general install settings
+export logdir="/var/log/djangosetup/"
+export aptlogloc=$logdir"apt.log"
+export aptlogmsg="See $aptlogloc for more info."
+export firelogloc=$logdir"firewall.log"
+export firelogmsg="See $firelogloc for more info."
+export pylogloc=$logdir"python.log"
+export pylogmsg="See $pylogloc for more info."
+export djalogloc=$logdir"django.log"
+export djamsg="See $djalogloc for more info."
+export gunicornlogloc=$logdir"gunicorn.log"
+export nginxlogloc=$logdir"nginx.log"
+export gitlogloc=$logdir"git.log"
+export gitlogmsg="See $gitlogloc for more info."
+
+# python settings
+export pylink="https://www.python.org/ftp/python/3.7.0/Python-3.7.0.tar.xz"
+export pyinstalldir="/usr/src/python37"