From 68283207bbf9af7469817ae4a47a388ce53a076d Mon Sep 17 00:00:00 2001 From: Antonio De Lucreziis Date: Wed, 13 Mar 2024 01:04:40 +0100 Subject: [PATCH] chore: updated readme --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8735d19..089cbdb 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ pnpm build ## Production Setup -Run the following command to bootstrap a **phCD** instance. As this service doesn't have auth for now, it's strongly recommended to publish only on a local ip like `127.0.0.1` and then access directly or via an ssh tunnel (something like `ssh -L 8080:127.0.0.1:8080 server`). +Run the following command to bootstrap a **phCD** instance. As this service _doesn't have auth_ for now, it's **strongly recommended** to publish only on a local ip like `127.0.0.1` and then access directly or via an ssh tunnel (something like `ssh -L 8080:127.0.0.1:8080 server`). ```bash # Clone this repo @@ -30,6 +30,10 @@ echo 'deploys: []' > config.yaml # Build and start the container docker compose up -d --build + +# Then just do the following to start and stop +docker compose down +docker compose up -d ``` ### Updating @@ -47,9 +51,11 @@ It should be possible to deploy itself using a git+dockerfile deployment. For no ~~**Idea 1.** Create another `self-update.Dockerfile` that also gets mounted `/var/run/docker.sock`, this new container will then run the previous commands~~ [...] if we want the volume to be a folder this cannot be easily done -## Architecture +## Configuration + +Everything is stored in the `config.yaml` file. It can be updated directly or from the web interface. -Everything is stored in the `config.yaml` file. This file contains a list of projects to deploy and the configuration for each one. +This file contains a list of projects to deploy and the configuration for each one, here is an example ```yaml deploys: @@ -79,3 +85,8 @@ deploys: path: ./deploy.sh # already the default ``` +### Schema of `config.yaml` + +TODO + +