Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for compose v2 #230

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ then put the new one in its place. For example:
```
mv docker-compose.yml docker-compose.old.yml
wget -O docker-compose.yml https://snikket.org/service/resources/docker-compose.beta.yml
docker-compose pull
docker-compose up -d --remove-orphans
docker compose pull
docker compose up -d --remove-orphans
```

You may also want to check out our new repository of scripts to help
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@ The easiest way is to use docker-compose. Copy the file `snikket.conf.example` t
`snikket.conf` and edit the values in it. Then run:

```console
docker-compose up -d
docker compose up -d
```
2 changes: 1 addition & 1 deletion docs/advanced/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ In most situations, the configuration options shown in the example config in
Also, it is very likely not complete.
{{< /panel >}}

After modifying any options in snikket.conf, you must run 'docker-compose up -d' to apply the changes.
After modifying any options in snikket.conf, you must run 'docker compose up -d' to apply the changes.

## Configuration Option Reference

Expand Down
10 changes: 5 additions & 5 deletions docs/setup/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ There are two options to fix this:

```
systemctl restart docker
docker-compose up -d # <- run this in your snikket directory
docker compose up -d # <- run this in your snikket directory
```

## Certificate problems
Expand Down Expand Up @@ -176,15 +176,15 @@ problem could be, check the error log:

```
cd /etc/snikket
docker-compose exec snikket_certs cat /var/log/letsencrypt/errors.log
docker compose exec snikket_certs cat /var/log/letsencrypt/errors.log
```

If you get a "No such file or directory" error when running the above command,
inspect the debug log instead:

```
cd /etc/snikket
docker-compose exec snikket_certs cat /var/log/letsencrypt/letsencrypt.log | grep detail
docker compose exec snikket_certs cat /var/log/letsencrypt/letsencrypt.log | grep detail
```

#### Trying again
Expand All @@ -194,15 +194,15 @@ following command:

```
cd /etc/snikket
docker-compose exec snikket_certs /etc/cron.daily/certbot
docker compose exec snikket_certs /etc/cron.daily/certbot
```

If that command says that no certificates are due for renewal, but you need to
trigger a renewal anyway, run:

```
cd /etc/snikket
docker-compose exec snikket_certs su letsencrypt -- -c "certbot renew --config-dir /snikket/letsencrypt --cert-path /etc/ssl/certbot --force-renew"
docker compose exec snikket_certs su letsencrypt -- -c "certbot renew --config-dir /snikket/letsencrypt --cert-path /etc/ssl/certbot --force-renew"
```

Note that Let's Encrypt has strict [rate limits](https://letsencrypt.org/docs/rate-limits/) -
Expand Down
4 changes: 2 additions & 2 deletions docs/setup/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ on the website (most likely), then use these commands:

```
cd /etc/snikket
docker-compose pull
docker-compose up -d
docker compose pull
docker compose up -d
```

### snikket-selfhosted
Expand Down