chore(docs): change docker-compose to docker compose (#3007)

* update docker compose

* fix swag docker compose indentation

* and again....

* indentation for the second docker compose in the swag guide
This commit is contained in:
Kuchenpirat 2024-01-19 17:01:37 +01:00 committed by GitHub
parent 6acadbc52b
commit d17e46ee50
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 51 additions and 53 deletions

View File

@ -42,7 +42,7 @@ body:
id: logs id: logs
attributes: attributes:
label: Please provide relevant logs label: Please provide relevant logs
placeholder: For example from `docker-compose logs` or other system logs. placeholder: For example from `docker compose logs` or other system logs.
validations: validations:
required: true required: true
- type: textarea - type: textarea

View File

@ -5,7 +5,7 @@
To make the setup of a Reverse Proxy much easier, Linuxserver.io developed [SWAG](https://github.com/linuxserver/docker-swag) To make the setup of a Reverse Proxy much easier, Linuxserver.io developed [SWAG](https://github.com/linuxserver/docker-swag)
SWAG - Secure Web Application Gateway (formerly known as letsencrypt, no relation to Let's Encrypt™) sets up an Nginx web server and reverse proxy with PHP support and a built-in certbot client that automates free SSL server certificate generation and renewal processes (Let's Encrypt and ZeroSSL). It also contains fail2ban for intrusion prevention. SWAG - Secure Web Application Gateway (formerly known as letsencrypt, no relation to Let's Encrypt™) sets up an Nginx web server and reverse proxy with PHP support and a built-in certbot client that automates free SSL server certificate generation and renewal processes (Let's Encrypt and ZeroSSL). It also contains fail2ban for intrusion prevention.
## Step 1: Get a domain ## Step 1: Get a domain
@ -14,39 +14,38 @@ The first step is to grab a dynamic DNS if you don't have your own subdomain alr
## Step 2: Set-up SWAG ## Step 2: Set-up SWAG
Then you will need to set up SWAG, the variables of the docker-compose are explained on the Github page of [SWAG](https://github.com/linuxserver/docker-swag). Then you will need to set up SWAG, the variables of the docker-compose.yaml file are explained on the Github page of [SWAG](https://github.com/linuxserver/docker-swag).
This is an example of how to set it up using duckdns and docker-compose. This is an example of how to set it up using duckdns and docker compose.
!!! example "docker-compose.yml" !!! example "docker-compose.yaml"
```yaml ```yaml
version: "3.1" version: "3.1"
services: services:
swag: swag:
image: ghcr.io/linuxserver/swag image: ghcr.io/linuxserver/swag
container_name: swag container_name: swag
cap_add: cap_add:
- NET_ADMIN - NET_ADMIN
environment: environment:
- PUID=1000 - PUID=1000
- PGID=1000 - PGID=1000
- TZ=Europe/Brussels - TZ=Europe/Brussels
- URL=<mydomain.duckdns> - URL=<mydomain.duckdns>
- SUBDOMAINS=wildcard - SUBDOMAINS=wildcard
- VALIDATION=duckdns - VALIDATION=duckdns
- CERTPROVIDER= #optional - CERTPROVIDER= #optional
- DNSPLUGIN= #optional - DNSPLUGIN= #optional
- DUCKDNSTOKEN=<duckdnstoken> - DUCKDNSTOKEN=<duckdnstoken>
- EMAIL=<e-mail> #optional - EMAIL=<e-mail> #optional
- ONLY_SUBDOMAINS=false #optional - ONLY_SUBDOMAINS=false #optional
- EXTRA_DOMAINS=<extradomains> #optional - EXTRA_DOMAINS=<extradomains> #optional
- STAGING=false #optional - STAGING=false #optional
volumes: volumes:
- /etc/config/swag:/config - /etc/config/swag:/config
ports: ports:
- 443:443 - 443:443
- 80:80 #optional - 80:80 #optional
restart: unless-stopped restart: unless-stopped
``` ```
Don't forget to change the <code>mydomain.duckns</code> into your personal domain and the <code>duckdnstoken</code> into your token and remove the brackets. Don't forget to change the <code>mydomain.duckns</code> into your personal domain and the <code>duckdnstoken</code> into your token and remove the brackets.
@ -61,26 +60,25 @@ Alternatively, you can create a new file <code>mealie.subdomain.conf</code> in p
!!! example "mealie.subdomain.conf" !!! example "mealie.subdomain.conf"
```yaml ```yaml
server { server {
listen 443 ssl http2; listen 443 ssl http2;
listen [::]:443 ssl http2; listen [::]:443 ssl http2;
server_name mealie.*; server_name mealie.*;
include /config/nginx/ssl.conf; include /config/nginx/ssl.conf;
client_max_body_size 0; client_max_body_size 0;
location / { location / {
include /config/nginx/proxy.conf; include /config/nginx/proxy.conf;
include /config/nginx/resolver.conf; include /config/nginx/resolver.conf;
set $upstream_app mealie-frontend; set $upstream_app mealie-frontend;
set $upstream_port 3000; set $upstream_port 3000;
set $upstream_proto http; set $upstream_proto http;
proxy_pass $upstream_proto://$upstream_app:$upstream_port; proxy_pass $upstream_proto://$upstream_app:$upstream_port;
} }
}
}
``` ```
## Step 4: Port-forward port 443 ## Step 4: Port-forward port 443

View File

@ -72,7 +72,7 @@ After you've decided setup the files it's important to set a few ENV variables t
After you've configured your database and updated the `docker-compose.yaml` files, you can start Mealie by running the following command in the directory where you've added your `docker-compose.yaml`. After you've configured your database and updated the `docker-compose.yaml` files, you can start Mealie by running the following command in the directory where you've added your `docker-compose.yaml`.
```bash ```bash
$ docker-compose up -d $ docker compose up -d
``` ```
You should see the containers start up without error. You should now be able to access the Mealie frontend at [http://localhost:9925](http://localhost:9925). You should see the containers start up without error. You should now be able to access the Mealie frontend at [http://localhost:9925](http://localhost:9925).

View File

@ -19,6 +19,6 @@ If you are upgrading from pre-v1.0.0 to v1.0.0, make sure you read [Migrating to
## Docker ## Docker
For all setups using Docker the updating process looks something like this For all setups using Docker the updating process looks something like this
- Stop the container using `docker-compose down` - Stop the container using `docker compose down`
- Pull the latest image using `docker-compose pull` - Pull the latest image using `docker compose pull`
- Start the container again using `docker-compose up -d` - Start the container again using `docker compose up -d`

File diff suppressed because one or more lines are too long

View File

@ -123,7 +123,7 @@ frontend-lint: ## 🧺 Run yarn lint
# Docker makefile # Docker makefile
prod: ## 🐳 Build and Start Docker Production Stack prod: ## 🐳 Build and Start Docker Production Stack
cd docker && docker compose -f docker-compose.yml -p mealie up --build cd docker && docker compose -f docker compose.yml -p mealie up --build
generate: generate:
poetry run python dev/code-generation/main.py poetry run python dev/code-generation/main.py