From 715784139b38d8f28606a92eee2b51d15f1aaa02 Mon Sep 17 00:00:00 2001
From: peeperklip <osamaboujdi@gmail.com>
Date: Fri, 23 Jul 2021 18:51:00 +0200
Subject: [PATCH] update readme, fix setup.sh and remove commented code from
 apache config template

---
 README.md                           | 26 +++++++++++++++++++++-----
 bin/setup.sh                        |  1 +
 templates/serverconfig/apache2.conf |  6 ------
 3 files changed, 22 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index d975b41..15cc768 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,36 @@
 # Set up a web server
-My Vagrant file + Ansible files
+<b>WIP. Do not rely on this on prod servers </b>
 
 ## Setup
+### Fetching the raw project files
 ```shell
 curl https://raw.githubusercontent.com/peeperklip/ansibles/master/bin/setup.sh | bash
 ```
 
+### Clone of the project files
+```shell
+git@github.com:peeperklip/ansibles.git
+```
+### Fork on GitHub
+In case you want to contribute commits
+* Create a fork on GitHub
+* Clone your fork locally
+
 ## Documentation
 ### Playbooks:
-* ...
+* playbooks/apt_upgrade.yml
+    * Used for the basic system maintenance
+* playbooks/create_webserver.yml
+    * sets up an NGINX or Apache2 webserver
+* playbooks/demo_file.yml
+    * deploys a symfony demo project (Will be deleted in the near future)
 
 ### Roles:
-* ...
+most roles will have their actions prefixed in their name with what they do en end with
 
 ### Misc:
-* ...
+* inventory/inventory.dist is an example inventory file meant to be copied and filled in
+* inventory/vagrant_demo_inventory is used if you're testing these files using vagrant
 
 ### Available playbooks:
 - Unzip
@@ -39,7 +55,7 @@ If you are working locally using vagrant, you need to add the line below to `/et
 ```
 192.168.33.10 vagrant.local
 ```
-The box required is: ubuntu 20.04
+The default box expected is ubuntu 20.04
 
 ### Executing on Vagrant
 ```bash
diff --git a/bin/setup.sh b/bin/setup.sh
index 535d198..72640e2 100644
--- a/bin/setup.sh
+++ b/bin/setup.sh
@@ -29,6 +29,7 @@ wget https://github.com/peeperklip/ansibles/archive/master.zip
 unzip master.zip
 rm master.zip
 rm ansibles-master/README.md
+rm ansibles-master/.gitignore
 mv ansibles-master/* .
 rmdir ansibles-master
 
diff --git a/templates/serverconfig/apache2.conf b/templates/serverconfig/apache2.conf
index 8777a15..b7eef49 100644
--- a/templates/serverconfig/apache2.conf
+++ b/templates/serverconfig/apache2.conf
@@ -8,12 +8,6 @@
         Require all granted
     </Directory>
 
-    # uncomment the following lines if you install assets as symlinks
-    # or run into problems when compiling LESS/Sass/CoffeeScript assets
-    # <Directory /var/www/project>
-    #     Options FollowSymlinks
-    # </Directory>
-
     ErrorLog {{ error_log_location | mandatory }}
     CustomLog {{ access_log_location | mandatory }} combined
 </VirtualHost>