From 80543a76a9c090c12c24b64dbe93610dd775730e Mon Sep 17 00:00:00 2001
From: Giles Bradshaw <giles.bradshaw@sigyl.com>
Date: Thu, 30 Apr 2020 12:52:56 +0100
Subject: [PATCH] .

---
 README.md               | 24 +++++++++++++++++++++---
 docker-compose-home.yml | 15 +++++++++++++--
 2 files changed, 34 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index efc06e7..8399de8 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,13 @@
 
 In a [docker](https://www.docker.com/) stack.
 
-## static ip
+### docker stack configuration
+
+[docker-compose-home.yml](docker-compose-home.yml)
+
+## deployments
+
+### static ip
 
 [![Build Status](https://sigyl.com:5000/api/badges/giles/stack/status.svg)](https://sigyl.com:5000/giles/stack)
 
@@ -19,9 +25,11 @@ In a [docker](https://www.docker.com/) stack.
 * guacamole - https://sigyl.com/remote/
 * chat - https://sigyl.com/chat/
 
-[drone.do.yml](drone.do.yml) - [docker-compose-do.yml](docker-compose-do.yml)
+#### starlark drone deployment file
 
-## tunnelled with ngrok
+[.drone-do.star](drone-do.star)
+
+### tunnelled with ngrok
 
 (very slow if home internet)
 
@@ -34,6 +42,10 @@ In a [docker](https://www.docker.com/) stack.
 * drone - https://drone.git.sigyl.com/
 * guacamole - https://git.sigyl.com/remote
 
+#### starlark drone deployment file
+
+[.drone-home.star](.drone-home.star)
+
 ## installation
 
 Once installed and running the system can redeploy itself.
@@ -330,3 +342,9 @@ Vist domain/ghost and set up admin user.
 ### chat
 
 Admin user is automatically created according to configured secrets
+
+### guacamole
+
+sign in with guacadmin guacadmin
+
+change password asap!
diff --git a/docker-compose-home.yml b/docker-compose-home.yml
index e6834b1..8889480 100644
--- a/docker-compose-home.yml
+++ b/docker-compose-home.yml
@@ -1,6 +1,8 @@
 version: "3.7"
 services:
   letsencrypt-git:
+    # nginx reverse proxy for all apps (except drone in a subdomain)
+    # automatically obtains and refreshes ssl certificates with letsencrypt
     deploy:
       placement:
         constraints: [node.labels.com.sigyl.git-stack == yes]
@@ -39,6 +41,7 @@ services:
       - 5000:5000
       - 5001:5001
   letsencrypt-drone:
+    # reverse proxy for drone in a subdomain
     deploy:
       placement:
         constraints: [node.labels.com.sigyl.git-stack == yes]
@@ -57,6 +60,7 @@ services:
     depends_on:
       - drone-server
   gitea:
+    # gitea application
     deploy:
       placement:
         constraints: [node.labels.com.sigyl.git-stack == yes]
@@ -77,6 +81,7 @@ services:
     networks:
       - appnet
   ngrok:
+    # ngrok tunnel client
     deploy:
       placement:
         constraints: [node.labels.com.sigyl.git-stack == yes]
@@ -98,6 +103,7 @@ services:
     networks:
       - appnet
   drone-server:
+    # drone server application
     deploy:
       placement:
         constraints: [node.labels.com.sigyl.git-stack == yes]
@@ -128,6 +134,7 @@ services:
     networks:
       - appnet
   drone-docker-runner:
+    # drone runner performs builds
     deploy:
       placement:
         constraints: [node.labels.com.sigyl.git-stack == yes]
@@ -146,6 +153,7 @@ services:
       - DRONE_RUNNER_CAPACITY=8
       - DRONE_RUNNER_NAME="docker-runner"
   drone-starlark:
+    # drone starlark server converts starlark to yaml
     deploy:
       placement:
         constraints: [node.labels.com.sigyl.git-stack == yes]
@@ -161,8 +169,8 @@ services:
       - SIGYL_STACK_ROOT=$SIGYL_STACK_ROOT
     networks:
       - appnet
-
   registry:
+    # internal registry
     deploy:
       placement:
         constraints: [node.labels.com.sigyl.git-stack == yes]
@@ -184,6 +192,7 @@ services:
     ports:
       - 5003:5000
   registry-1:
+    # internal registry #1 (why?)
     deploy:
       placement:
         constraints: [node.labels.com.sigyl.git-stack == yes]
@@ -198,6 +207,7 @@ services:
     networks:
       - appnet
   registry-cache:
+    # registry cache (used?)
     deploy:
       placement:
         constraints: [node.labels.com.sigyl.git-stack == yes]
@@ -219,8 +229,8 @@ services:
     secrets:
       - registry-cert
       - registry-key  
-  
   ghost:
+    # ghost blog
     deploy:
       placement:
         constraints: [node.labels.com.sigyl.git-stack == yes]
@@ -241,6 +251,7 @@ services:
       - appnet
   
   guacamole-postgresql:
+    # database for guacamole
     deploy:
       placement:
         constraints: [node.labels.com.sigyl.git-stack-data == yes]