feat: update readme
This commit is contained in:
parent
a46b00bd07
commit
9f40e247b9
16
README.md
16
README.md
@ -15,7 +15,7 @@
|
|||||||
1. Clone this repository and navigate into the directory.
|
1. Clone this repository and navigate into the directory.
|
||||||
|
|
||||||
2. Start the services:
|
2. Start the services:
|
||||||
```bash
|
```shell
|
||||||
docker compose up -d
|
docker compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -25,7 +25,7 @@ Download the `roots.pem` from [https://localhost:9000/roots.pem](https://localho
|
|||||||
This is necessary for the certificates to be trusted by your browser.
|
This is necessary for the certificates to be trusted by your browser.
|
||||||
|
|
||||||
- Linux
|
- Linux
|
||||||
```bash
|
```shell
|
||||||
sudo trust anchor --store roots.pem
|
sudo trust anchor --store roots.pem
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -35,7 +35,7 @@ Import-Certificate -FilePath "roots.pem" -CertStoreLocation "Cert:\LocalMachine\
|
|||||||
```
|
```
|
||||||
|
|
||||||
- macOS
|
- macOS
|
||||||
```bash
|
```shell
|
||||||
sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain roots.pem
|
sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain roots.pem
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -62,7 +62,7 @@ labels:
|
|||||||
> For each overwritten port you need to specify a custom `service-label` `traefik.http.services.[service-label]`. Otherwise the custom port will not be detected.
|
> For each overwritten port you need to specify a custom `service-label` `traefik.http.services.[service-label]`. Otherwise the custom port will not be detected.
|
||||||
|
|
||||||
- If certificates are not renewed or have expired
|
- If certificates are not renewed or have expired
|
||||||
```bash
|
```shell
|
||||||
docker compose up -d --force-recreate traefik
|
docker compose up -d --force-recreate traefik
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -91,7 +91,7 @@ Replace `.dev.local` with your custom domain suffix in the `config/dns/config.sa
|
|||||||
```
|
```
|
||||||
|
|
||||||
Restart the docker services to apply the changes:
|
Restart the docker services to apply the changes:
|
||||||
```bash
|
```shell
|
||||||
docker compose down
|
docker compose down
|
||||||
docker compose up -d --force-recreate
|
docker compose up -d --force-recreate
|
||||||
```
|
```
|
||||||
@ -110,7 +110,7 @@ The service would now be reachable at `https://my-app.very.cool` and `https://my
|
|||||||
### Certificate Lifetime
|
### Certificate Lifetime
|
||||||
|
|
||||||
To ensure Traefik has enough time to renew certificates, increase their duration:
|
To ensure Traefik has enough time to renew certificates, increase their duration:
|
||||||
```bash
|
```shell
|
||||||
docker compose exec step step ca provisioner update acme \
|
docker compose exec step step ca provisioner update acme \
|
||||||
--x509-min-dur=20m \
|
--x509-min-dur=20m \
|
||||||
--x509-max-dur=8760h \
|
--x509-max-dur=8760h \
|
||||||
@ -119,8 +119,8 @@ docker compose exec step step ca provisioner update acme \
|
|||||||
|
|
||||||
### Use the preconfigured services
|
### Use the preconfigured services
|
||||||
|
|
||||||
If you use the preconfigured services, you can add the following snippet to you `.bashrc/.zshrc` to easily start, stop, and manage the services.
|
If you use the preconfigured services, you can add the following snippet to you `.bashrc`/`.zshrc` to easily start, stop, and manage the services.
|
||||||
```bash
|
```shell
|
||||||
dev () {
|
dev () {
|
||||||
PROJECT_DIR="$HOME/Projects/dev/services"
|
PROJECT_DIR="$HOME/Projects/dev/services"
|
||||||
case "$1" in
|
case "$1" in
|
||||||
|
Loading…
x
Reference in New Issue
Block a user