Update READMEs

README.md

@@ -6,7 +6,7 @@ Vault password managed by `vault_pass.py` through the [Bitwarden CLI](https://bi
 
 Only work on Debian(-based) systems.
 
-Reminder dependencies are installed via `ansible-galaxy install -r requirements.yaml`
+Reminder dependencies are installed via `ansible-galaxy install -r requirements.yaml`.
 
 
 ## Roles

roles/gotify_notifier/README.md

@@ -6,20 +6,10 @@ Sets up a script that makes it simple to send a notification to a gotify server.
 Variables
 ------------
 `gotify_host` must be defined as a FQDN, e.g. "https://gotify.example.com".
+
 `gotify_token` must be defined.
 
 Requirements
 ------------
 
 Must be run as root or using `become` if script is to be copied to PATH. None otherwise.
-
-Dependencies
-------------
-
-None.
-
-Todo
-------------
-
-- Copy script to specified path rather than PATH
-- Better way to add it to PATH?

roles/provision/README.md

@@ -1,7 +1,8 @@
 provision
 =========
 
-Does first five minutes security, sets up user account and installs some packages.
+Does first five minutes security, sets up user account, installs packages and sets up dotfiles.
+Each part of that can be done separately by specifying the appropriate tag.
 
 Variables
 ------------
@@ -10,17 +11,12 @@ Variables
 
 `is_vm` may be defined as true to install qemu guest agent.
 
-Requirements
-------------
+`is_wsl` may be defined to set WSL to use systemd.
 
-Must be run as root or using `become`.
+`copy_private_key` may be defined to copy the SSH private key as well as authorising the public key.
 
-Dependencies
+Requirements
 ------------
 
-None.
-
-Todo
-------------
+System, account and SSH setup must be run with `become`, dotfiles can be run without.
 
-None.

roles/services/dockerhost/README.md

@@ -3,13 +3,13 @@ dockerhost
 
 Sets up VM as a host for various docker applications
 
-
-
 Variables
 ------------
 
 `dockerhost_socket_network_name` is the name of the network in which the Docker socket proxy lives
 
+`services` is a list of the names of each service you want to run. A corresponding compose file should exist in the templates dir.
+
 Requirements
 ------------
 
@@ -23,5 +23,5 @@ Role `geerlingguy.docker` must be present.
 Todo
 ------------
 
-- Config directories overzetten
-- cron job voor backup als root, notification als jonathan
+- Copy config directories
+- cron job voor backup ass `root`, notification as `username`

roles/services/npm/README.md

@@ -23,5 +23,4 @@ The collection `community.docker` and role `geerlingguy.docker`.
 
 Todo
 ------------
-- Does this set things up in root directory?
 - Set up template files for config

roles/services/postgres/README.md

@@ -1,8 +1,8 @@
 Postgres
 =========
-Role to set a server up as a Postgres database.
-
 
+Role to set a server up as a Postgres database.
+Not actually useful, just for playing around so far.
 
 Requirements
 ------------

roles/services/transmission/README.md

@@ -3,6 +3,8 @@ transmission
 
 Sets up transmission VM.
 
+Currently majorly outdated as I don't use NFS anymore.
+
 Installs `transmission-gtk`, mounts `/big-store/transmission` and creates a symbolic link to the mount in the user's home directory.
 
 Variables