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

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

Merged
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ body:
id: logs
attributes:
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:
required: true
- type: textarea
Expand Down
90 changes: 44 additions & 46 deletions docs/docs/documentation/community-guide/swag.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

## Step 1: Get a domain
Expand All @@ -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

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).
This is an example of how to set it up using duckdns and docker-compose.
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.

!!! example "docker-compose.yml"
!!! example "docker-compose.yaml"
```yaml
version: "3.1"
services:
swag:
image: ghcr.io/linuxserver/swag
container_name: swag
cap_add:
- NET_ADMIN
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/Brussels
- URL=<mydomain.duckdns>
- SUBDOMAINS=wildcard
- VALIDATION=duckdns
- CERTPROVIDER= #optional
- DNSPLUGIN= #optional
- DUCKDNSTOKEN=<duckdnstoken>
- EMAIL=<e-mail> #optional
- ONLY_SUBDOMAINS=false #optional
- EXTRA_DOMAINS=<extradomains> #optional
- STAGING=false #optional
volumes:
- /etc/config/swag:/config
ports:
- 443:443
- 80:80 #optional
restart: unless-stopped

swag:
image: ghcr.io/linuxserver/swag
container_name: swag
cap_add:
- NET_ADMIN
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/Brussels
- URL=<mydomain.duckdns>
- SUBDOMAINS=wildcard
- VALIDATION=duckdns
- CERTPROVIDER= #optional
- DNSPLUGIN= #optional
- DUCKDNSTOKEN=<duckdnstoken>
- EMAIL=<e-mail> #optional
- ONLY_SUBDOMAINS=false #optional
- EXTRA_DOMAINS=<extradomains> #optional
- STAGING=false #optional
volumes:
- /etc/config/swag:/config
ports:
- 443:443
- 80:80 #optional
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.
Expand All @@ -61,26 +60,25 @@ Alternatively, you can create a new file <code>mealie.subdomain.conf</code> in p

!!! example "mealie.subdomain.conf"
```yaml
server {
listen 443 ssl http2;
listen [::]:443 ssl http2;

server_name mealie.*;
server {
listen 443 ssl http2;
listen [::]:443 ssl http2;

include /config/nginx/ssl.conf;
server_name mealie.*;

client_max_body_size 0;
include /config/nginx/ssl.conf;

location / {
include /config/nginx/proxy.conf;
include /config/nginx/resolver.conf;
set $upstream_app mealie-frontend;
set $upstream_port 3000;
set $upstream_proto http;
proxy_pass $upstream_proto://$upstream_app:$upstream_port;
}
client_max_body_size 0;

}
location / {
include /config/nginx/proxy.conf;
include /config/nginx/resolver.conf;
set $upstream_app mealie-frontend;
set $upstream_port 3000;
set $upstream_proto http;
proxy_pass $upstream_proto://$upstream_app:$upstream_port;
}
}
```

## Step 4: Port-forward port 443
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

```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).
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/documentation/getting-started/updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ If you are upgrading from pre-v1.0.0 to v1.0.0, make sure you read [Migrating to
## Docker
For all setups using Docker the updating process looks something like this

- Stop the container using `docker-compose down`
- Pull the latest image using `docker-compose pull`
- Start the container again using `docker-compose up -d`
- Stop the container using `docker compose down`
- Pull the latest image using `docker compose pull`
- Start the container again using `docker compose up -d`
2 changes: 1 addition & 1 deletion docs/docs/overrides/api.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion makefile
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ frontend-lint: ## 🧺 Run yarn lint
# Docker makefile

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:
poetry run python dev/code-generation/main.py