ansv7779/action-branch-deploy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor style fixes

Browse Source
This commit is contained in:
Andreas Svanberg 2024-10-31 14:18:07 +01:00
parent deb184d06c
commit be62417d93
1 changed files with 8 additions and 1 deletions

9
README.md

@ -20,6 +20,13 @@ This action takes the current branch (that triggered the workflow) and clones it
compose-file: compose.yaml
```
## TLDR
* Create your own network for inter-service communication
* Join Traefik network on exposed services
* Add Traefik routing labels to exposed services
* Use environment variable `COMPOSE_PROJECT_NAME` for unique values
* Environment variable `VHOST` is the fully qualified hostname for your deployment
## Inputs
### gitea-token
The token used to authenticate with the Gitea API.
@ -113,7 +120,7 @@ accessed using the environment variable `${VHOST}`. This is a fully qualified ho
deployment and can be prefixed if there's a need for multiple hosts. Do *not* use `.` in the hostname.
### Example Compose file
This below Compose file consists of three services, a `frontend` that runs in the browser, an `api` that is used by the
The below Compose file consists of three services: a `frontend` that runs in the browser, an `api` that is used by the
frontend and a `db` that is used by the `api`. The `frontend` service is exposed to the outside world, as is the `api`
service as it is meant to be accessed by the application running in the browser. However, it uses a different host than
what is used by the `frontend` and that hostname is passed as an environment variable to the `frontend` so it knows