Files
templates/blueprints/fivem/docker-compose.yml
Shishir Ahmed eaf5fd5f7e Add FiveM server template with dual deployment modes (#393)
* feat: Added fivem server

* feat: add FiveM server template with dual deployment modes

feat: add FiveM server template with dual deployment modes

- Add docker-compose.yml with spritsail/fivem image
- Support both standard FiveM server and txAdmin web interface modes
- Configure environment variables for license key management
- Add comprehensive documentation for deployment modes
- Include template.toml with optional license key configuration
- Add FiveM logo and meta.json entry
- Support persistent storage for config and txAdmin data
- Configure proper port mapping (30120 game, 40120 web UI)
- Add interactive TTY setup required for FiveM container

Template supports two modes:
- Standard: Direct server with LICENSE_KEY env var
- txAdmin: Web management with NO_DEFAULT_CONFIG=1

* docs: add deployment mode awareness to FiveM docker-compose

docs: clarify FiveM deployment modes in docker-compose

Add detailed comments explaining standard server vs txAdmin modes
to prevent configuration errors and licensing issues.

* Added all env variables.

* fix: follow Dokploy template.toml format
2025-09-27 14:38:46 -06:00

41 lines
1.1 KiB
YAML

# docker-compose.yml
#
# IMPORTANT: FiveM Template - Two Deployment Modes
#
# MODE 1: Standard FiveM Server
# - Set LICENSE_KEY environment variable (get free from https://forum.fivem.net/)
# - Leave NO_DEFAULT_CONFIG empty or unset
# - Server configured via /config files
# - No web management interface
#
# MODE 2: txAdmin Web Interface
# - Set NO_DEFAULT_CONFIG=1
# - DO NOT set LICENSE_KEY (configure via web UI)
# - Access web management at https://your-domain
# - License configured through txAdmin interface
#
# WARNING: Don't mix modes! Setting both LICENSE_KEY and NO_DEFAULT_CONFIG=1 causes errors
#
services:
fivem:
image: spritsail/fivem:latest
restart: unless-stopped
tty: true
stdin_open: true
environment:
- LICENSE_KEY=${license_key}
- RCON_PASSWORD=${rcon_password}
- NO_DEFAULT_CONFIG=${NO_DEFAULT_CONFIG:-}
volumes:
- fivem_config:/config
- fivem_txdata:/txData
ports:
- 30120:30120
- 30120:30120/udp
- 40120
labels:
- "traefik.enable=true"
volumes:
fivem_config:
fivem_txdata: