diff --git a/README.md b/README.md index ff6a81a..555e529 100644 --- a/README.md +++ b/README.md @@ -68,9 +68,9 @@ If you want to use local folders instead of Docker volumes, see [examples/docker You can find more installation and configuration guides here: -- [SSL Certificate Guide](docs/ssl-certificates-guide.md) -- [systemd Guide](docs/systemd-guide.md) -- [Unraid Installation Guide](docs/unraid-installation-guide.md) +- [SSL Certificate Guide](https://github.com/ckulka/baikal-docker/blob/master/docs/ssl-certificates-guide.md) +- [systemd Guide](https://github.com/ckulka/baikal-docker/blob/master/docs/systemd-guide.md) +- [Unraid Installation Guide](https://github.com/ckulka/baikal-docker/blob/master/docs/unraid-installation-guide.md) ## Image Variants @@ -78,7 +78,7 @@ The `ckulka/baikal` images come in several flavors, each designed for a specific ### `ckulka/baikal:` -This is the defacto image, as follows the official guidelines the closest using Apache httpd. +This is the defacto image and follows the official guidelines the closest using Apache httpd. With that being said, it's worth checking out the `nginx` variant as it requires fewer resources, e.g. memory, and is a lot smaller in size. @@ -88,7 +88,7 @@ If you are unsure about what your needs are, you probably want to use this one t This image relies on Apache httpd and uses the [official PHP image](https://hub.docker.com/_/php/) that's packaged with the Apache web server. -It also ships with HTTPS support and self-signed certificates, which can be replaced by user-provided certificates - for more details, see the _SSL Certificates: Static Certificates_ section. +It also ships with HTTPS support and self-signed certificates, which can be replaced by user-provided certificates - for more details, see the [SSL Certificate Guide](https://github.com/ckulka/baikal-docker/blob/master/docs/ssl-certificates-guide.md). This image uses environment variables to set Apache's `ServerName` and `ServerAlias` directives to avoid Apache httpd's warnings in the logs. @@ -98,7 +98,7 @@ The `BAIKAL_SERVERALIAS` environment variable is used to set the `ServerAlias` d ### `ckulka/baikal:experimental` -This image builds the `master` branch from the source repository [ckulka/baikal-docker](https://github.com/ckulka/baikal-docker). Use at your own risk. +This image has the latest code from the source repository [ckulka/baikal-docker](https://github.com/ckulka/baikal-docker), mainly used for testing before a version is released. Use this at your own risk. ### `ckulka/baikal:nginx` diff --git a/docs/ssl-certificates-guide.md b/docs/ssl-certificates-guide.md index 240d9d9..d8a612e 100644 --- a/docs/ssl-certificates-guide.md +++ b/docs/ssl-certificates-guide.md @@ -10,7 +10,7 @@ This is my recommended approach, as your other containers can easily be added an I included an example Docker Compose file [examples/docker-compose.ssl.yaml](https://github.com/ckulka/baikal-docker/blob/master/examples/docker-compose.ssl.yaml) as a template. -For more details on the Traefik configuration, see [Traefik's Docker](https://docs.traefik.io/configuration/backends/docker/) and [Traefik's Let's Encrypt](https://docs.traefik.io/configuration/acme/) docs. +For more details on the Traefik configuration, see [Traefik's Docker](https://doc.traefik.io/traefik/providers/docker/) and [Traefik's Let's Encrypt](https://doc.traefik.io/traefik/https/acme/) docs. ## Static Certificates