phc/phcd
6
1
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases Wiki Activity

chore: updated readme

Browse Source
This commit is contained in:
aziis98
2024-03-13 01:04:40 +01:00
parent f3cd0ce1e3
commit 68283207bb
1 changed files with 14 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14 -3
View File
@@ -17,7 +17,7 @@ pnpm build
## Production Setup ## 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 ```bash
# Clone this repo # Clone this repo
@@ -30,6 +30,10 @@ echo 'deploys: []' > config.yaml
# Build and start the container # Build and start the container
docker compose up -d --build docker compose up -d --build
# Then just do the following to start and stop
docker compose down
docker compose up -d
``` ```
### Updating ### 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 ~~**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. This file contains a list of projects to deploy and the configuration for each one. Everything is stored in the `config.yaml` file. It can be updated directly or from the web interface.
This file contains a list of projects to deploy and the configuration for each one, here is an example
```yaml ```yaml
deploys: deploys:
@@ -79,3 +85,8 @@ deploys:
path: ./deploy.sh # already the default path: ./deploy.sh # already the default
``` ```
### Schema of `config.yaml`
TODO