From 46418125e3026834cc110674fe77262607f55811 Mon Sep 17 00:00:00 2001
From: mbecker20 <becker.maxh@gmail.com>
Date: Mon, 7 Oct 2024 18:53:43 -0400
Subject: [PATCH] update docs for periphery systemd --user install

---
 scripts/readme.md | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

diff --git a/scripts/readme.md b/scripts/readme.md
index fa5307de6..a925f25da 100644
--- a/scripts/readme.md
+++ b/scripts/readme.md
@@ -25,9 +25,6 @@ Will install to paths:
 
 *Note*. The user running periphery must be a member of the docker group, in order to use the docker cli without sudo.
 
-*Note*. Ensure the user running periphery has write access to the configure [repo directory](https://github.com/mbecker20/komodo/blob/main/config/periphery.config.toml).
-This allows periphery to clone repos and write compose files.
-
 ```sh
 curl -sSL https://raw.githubusercontent.com/mbecker20/komodo/main/scripts/setup-periphery.py | python3 - --user
 ```
@@ -35,4 +32,17 @@ curl -sSL https://raw.githubusercontent.com/mbecker20/komodo/main/scripts/setup-
 Will install to paths:
 - periphery (binary) -> `$HOME/.local/bin`
 - periphery.service -> `$HOME/.config/systemd/user/periphery.service`
-- periphery.config.toml -> `$HOME/.config/komodo/periphery.config.toml`
\ No newline at end of file
+- periphery.config.toml -> `$HOME/.config/komodo/periphery.config.toml`
+
+*Note*. Ensure the user running periphery has write permissions to the configured folders `repo_dir`, `stack_dir`, and `ssl_key_file` / `ssl_cert_file` parent folder.
+This allows periphery to clone repos, write compose files, and generate ssl certs.
+
+For example in `periphery.config.toml`, running under `ubuntu` user:
+```toml
+repo_dir = "/home/ubuntu/.komodo/repos"
+stack_dir = "/home/ubuntu/.komodo/stacks"
+
+ssl_enabled = true
+ssl_key_file = "/home/ubuntu/.komodo/ssl/key.pem"
+ssl_cert_file = "/home/ubuntu/.komodo/ssl/cert.pem"
+```
\ No newline at end of file