mirrors/crafty-documentation
1
0
Fork 0
mirror of https://gitlab.com/crafty-controller/crafty-documentation.git synced 2025-12-05 01:10:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Normalise indentation on compose examples

Browse Source
This commit is contained in:
Zedifus
2025-06-15 23:51:35 +01:00
parent 0a661996ad
commit fc9d7b99cf
2 changed files with 89 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
docs/pages/getting-started/installation/docker.md
View File

@@ -139,26 +139,24 @@ The Crafty Docker images can be deployed in multiple ways:
=== "Pre-built image `docker-compose.yml`"
``` yaml linenums="1"
version: '3'
services:
crafty:
container_name: crafty_container
image: registry.gitlab.com/crafty-controller/crafty-4:latest
restart: always
environment:
- TZ=Etc/UTC
ports:
- "8443:8443" # HTTPS
- "8123:8123" # DYNMAP
- "19132:19132/udp" # BEDROCK
- "25500-25600:25500-25600" # MC SERV PORT RANGE
volumes:
- ./docker/backups:/crafty/backups
- ./docker/logs:/crafty/logs
- ./docker/servers:/crafty/servers
- ./docker/config:/crafty/app/config
- ./docker/import:/crafty/import
crafty:
container_name: crafty_container
image: registry.gitlab.com/crafty-controller/crafty-4:latest
restart: always
environment:
- TZ=Etc/UTC
ports:
- "8443:8443" # HTTPS
- "8123:8123" # DYNMAP
- "19132:19132/udp" # BEDROCK
- "25500-25600:25500-25600" # MC SERV PORT RANGE
volumes:
- ./docker/backups:/crafty/backups
- ./docker/logs:/crafty/logs
- ./docker/servers:/crafty/servers
- ./docker/config:/crafty/app/config
- ./docker/import:/crafty/import
```
``` shell
docker-compose up -d && docker-compose logs -f
@@ -166,26 +164,24 @@ The Crafty Docker images can be deployed in multiple ways:
=== "Portainer Stack :simple-portainer:"
``` yaml linenums="1"
version: '3'
services:
crafty:
container_name: crafty_container
image: registry.gitlab.com/crafty-controller/crafty-4:latest
restart: always
environment:
- TZ=Etc/UTC
ports:
- "8443:8443" # HTTPS
- "8123:8123" # DYNMAP
- "19132:19132/udp" # BEDROCK
- "25500-25600:25500-25600" # MC SERV PORT RANGE
volumes:
- /srv/docker/crafty-4/backups:/crafty/backups
- /srv/docker/crafty-4/logs:/crafty/logs
- /srv/docker/crafty-4/servers:/crafty/servers
- /srv/docker/crafty-4/config:/crafty/app/config
- /srv/docker/crafty-4/import:/crafty/import
crafty:
container_name: crafty_container
image: registry.gitlab.com/crafty-controller/crafty-4:latest
restart: always
environment:
- TZ=Etc/UTC
ports:
- "8443:8443" # HTTPS
- "8123:8123" # DYNMAP
- "19132:19132/udp" # BEDROCK
- "25500-25600:25500-25600" # MC SERV PORT RANGE
volumes:
- /srv/docker/crafty-4/backups:/crafty/backups
- /srv/docker/crafty-4/logs:/crafty/logs
- /srv/docker/crafty-4/servers:/crafty/servers
- /srv/docker/crafty-4/config:/crafty/app/config
- /srv/docker/crafty-4/import:/crafty/import
```
!!! note ""
Notice, we've chosen **absolute paths** instead of the other examples that use **relative**!
@@ -233,14 +229,14 @@ The following is a list of the ports that are required:
left most option(external) in the previous examples.
``` yaml
---Engine ---
# Engine
-p external:internal
---Compose---
# Compose
services:
crafty:
ports:
- "external:internal";
crafty:
ports:
- "external:internal";
```
You can as well bind host networking as another option, This is pretty overkill and This will discard any published ports, It is useful to optimize performance in situations where a large range of ports is required...<br>

103
docs/pages/getting-started/proxies.md
View File

@@ -151,61 +151,58 @@ Reverse proxies are used to make hosted applications accessible to the internet,
```
``` yaml title="Monolithic docker-compose.yml"
version: "3"
services:
swag:
image: linuxserver/swag
container_name: swag
cap_add:
- NET_ADMIN
networks:
- swag
environment:
- PUID=${USER_ID}
- PGID=${GROUP_ID}
- TZ=${TZ}
- URL=${URL}
- SUBDOMAINS=${SUBDOMAINS}
- VALIDATION=http
- DNSPLUGIN=cloudflare #optional
- PROPAGATION= #optional
- DUCKDNSTOKEN= #optional
- EMAIL=${EMAIL} #optional
- ONLY_SUBDOMAINS=${ONLY_SUBDOMAINS} #optional
- EXTRA_DOMAINS= #optional
- STAGING=false #optional Set staging to true so you don't get rate limited by LetsEncrypt if you're having issues with cert gen
volumes:
- ./swag:/config
ports:
- 443:443
- 80:80 #optional
restart: unless-stopped
crafty:
container_name: crafty_container
image: registry.gitlab.com/crafty-controller/crafty-4:latest
restart: unless-stopped
depends_on:
- swag
environment:
- TZ=Etc/UTC
ports:
- "8000:8000" # HTTP
- "8443:8443" # HTTPS
- "8123:8123" # DYNMAP
- "19132:19132/udp" # BEDROCK
- "25500-25600:25500-25600" # MC SERV PORT RANGE
volumes:
- ./crafty/backups:/crafty/backups
- ./crafty/logs:/crafty/logs
- ./crafty/servers:/crafty/servers
- ./crafty/config:/crafty/app/config
- ./crafty/import:/crafty/import
networks:
- swag
swag:
image: linuxserver/swag
container_name: swag
cap_add:
- NET_ADMIN
networks:
- swag
environment:
- PUID=${USER_ID}
- PGID=${GROUP_ID}
- TZ=${TZ}
- URL=${URL}
- SUBDOMAINS=${SUBDOMAINS}
- VALIDATION=http
- DNSPLUGIN=cloudflare #optional
- PROPAGATION= #optional
- DUCKDNSTOKEN= #optional
- EMAIL=${EMAIL} #optional
- ONLY_SUBDOMAINS=${ONLY_SUBDOMAINS} #optional
- EXTRA_DOMAINS= #optional
- STAGING=false #optional Set staging to true so you don't get rate limited by LetsEncrypt if you're having issues with cert gen
volumes:
- ./swag:/config
ports:
- 443:443
- 80:80 #optional
restart: unless-stopped
crafty:
container_name: crafty_container
image: registry.gitlab.com/crafty-controller/crafty-4:latest
restart: unless-stopped
depends_on:
- swag
networks:
- swag
environment:
- TZ=Etc/UTC
ports:
- "8443:8443" # HTTPS
- "8123:8123" # DYNMAP
- "19132:19132/udp" # BEDROCK
- "25500-25600:25500-25600" # MC SERV PORT RANGE
volumes:
- ./crafty/backups:/crafty/backups
- ./crafty/logs:/crafty/logs
- ./crafty/servers:/crafty/servers
- ./crafty/config:/crafty/app/config
- ./crafty/import:/crafty/import
networks:
swag:
name: swag
swag:
name: swag
```
``` CONF title="./config/nginx/proxy-confs/crafty.subdomain.conf"