Add documentation for setting it up

Quansight · May 27, 2020 · 794df9a · 794df9a
1 parent 76ae708
commit 794df9a
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,18 @@
 # Ansible Tutorial
 
+A basic Django app with postgres as database deployed on DigitalOcean (droplet) via Ansible.
+
+## Environment variables
+
+Create a `.env` file in the root of the cloned repository, with following variables:
+
+```bash
+POSTGRES_DB=sample
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD="set strong password for postgres"
+SUPERUSER_PASSWORD="set strong password for django admin dashboard"
+DO_API_TOKEN="Digital Ocean token, if deploying"
+```
 
 ## Running the app
 
@@ -13,3 +26,15 @@ docker-compose build
 ```bash
 docker-compose up
 ```
+
+After running the commands above, the app should be running at:
+http://127.0.0.1:8000/
+
+## Deployment
+
+This is deployed on Digital Ocean Droplet via Ansible. To deploy run the
+following command after `docker-compose up`:
+
+```bash
+docker-compose exec web ansible-playbook deployment/site.yml
+```
diff --git a/deployment/repository.yml → deployment/clone_repository.yml b/deployment/repository.yml → deployment/clone_repository.yml
diff --git a/deployment/compose.yml → deployment/compose_start.yml b/deployment/compose.yml → deployment/compose_start.yml
diff --git a/deployment/docker.yml → deployment/docker_setup.yml b/deployment/docker.yml → deployment/docker_setup.yml
diff --git a/deployment/main.yml b/deployment/main.yml
diff --git a/deployment/site.yml b/deployment/site.yml
@@ -0,0 +1,5 @@
+---
+- import_playbook: digital_ocean_droplet.yml
+- import_playbook: docker_setup.yml
+- import_playbook: clone_repository.yml
+- import_playbook: compose_start.yml