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

Grammatical improvements

Browse Source
This commit is contained in:
Andreas Svanberg 2024-10-31 11:02:46 +01:00
parent 32fb77e055
commit a49384214c
1 changed files with 3 additions and 3 deletions

6
README.md

@ -1,6 +1,6 @@
# Action for Docker Compose deployment to branch.dsv.su.se
This actions take the current branch (that triggered the workflow) and clones it to the branch.dsv.su.se server and runs `docker compose -f ${compose-file} up` and gives you back a URL pointing to the deployment.
This action take the current branch (that triggered the workflow) and clones it to the branch.dsv.su.se server and runs `docker compose -f ${compose-file} up` and gives you back a URL pointing to the deployment.
> [!IMPORTANT]
> Please read the section [about the Compose file](#compose-file-1)
@ -56,7 +56,7 @@ labels:
What do all these labels mean? First one tells Traefik that this container should have traffic routed to it. The `rule` says which traffic.
`tls.certresolver` tells Traefik how to generate HTTPS certificate, the only valid value is `letsencrypt`. Unfortunately this has to be specified on each exposed service since there is no way to set a default.
There is one final thing to do which is have your Traefik-enabled services join the `traefik` network. This is done using the [top-level element `networks`](https://docs.docker.com/reference/compose-file/networks/). This is an existing network that your services should join, not create, so `external: true` is specified.
There is one final thing to do which is to have your Traefik-enabled services join the `traefik` network. This is done using the [top-level element `networks`](https://docs.docker.com/reference/compose-file/networks/). This is an existing network that your services should join, not create, so `external: true` is specified.
```
networks:
@ -65,7 +65,7 @@ networks:
external: true
```
Not all your services should join this network but you still want them to be able to communicate with each other. For that you should define a second network used by those services that need to communicate.
Not all your services should join this network, but you still want them to be able to communicate with each other. For that you should define a second network used by those services that need to communicate.
### So what is that ${COMPOSE_PROJECT_NAME} and ${VHOST}?
The labels added to your service will define a new Traefik [router](https://doc.traefik.io/traefik/routing/routers/) and each router must have a unique name. [`${COMPOSE_PROJECT_NAME}`](https://docs.docker.com/compose/how-tos/environment-variables/envvars/#compose_project_name) is used since it has a unique value already or there would be conflicts between common service names such as `web` or `db`.