Add FiveM server template with dual deployment modes#393
Merged
Siumauricio merged 5 commits intoDokploy:mainfrom Sep 27, 2025
Merged
Add FiveM server template with dual deployment modes#393Siumauricio merged 5 commits intoDokploy:mainfrom
Siumauricio merged 5 commits intoDokploy:mainfrom
Conversation
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: clarify FiveM deployment modes in docker-compose Add detailed comments explaining standard server vs txAdmin modes to prevent configuration errors and licensing issues.
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
Contributor
|
Approved |
Siumauricio
requested changes
Sep 26, 2025
blueprints/fivem/template.toml
Outdated
Comment on lines
+6
to
+13
| { name = "LICENSE_KEY", description = "FiveM server license key (obtain free from https://forum.fivem.net/) - ONLY for standard mode, leave empty if using txAdmin", required = false }, | ||
| { name = "RCON_PASSWORD", description = "RCON password for server management (optional - random 16 char password assigned if not specified)", required = false }, | ||
| { name = "NO_DEFAULT_CONFIG", description = "Set to '1' to enable txAdmin web interface (license configured via web UI), leave empty for standard FiveM server (requires LICENSE_KEY)", required = false }, | ||
| { name = "NO_LICENSE_KEY", description = "Set to '1' to disable license key in environment (useful if license is in config file)", required = false }, | ||
| { name = "NO_ONESYNC", description = "Set to '1' to disable OneSync being added to default configs", required = false } | ||
| ] | ||
| mounts = [] | ||
|
|
Contributor
There was a problem hiding this comment.
Please follow this instructions https://github.com/Dokploy/templates?tab=readme-ov-file#general-suggestions-when-creating-a-template
Contributor
Author
There was a problem hiding this comment.
@Siumauricio Done. I've fixed the template.toml format.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📝 Description
Adds a new FiveM template to the Dokploy templates repository. FiveM is a popular modded GTA V multiplayer server platform with two distinct deployment approaches.
✨ What's Added
🎮 Features
🔧 Deployment Modes
Mode 1: Standard Server
LICENSE_KEYenvironment variableMode 2: txAdmin Web Interface
NO_DEFAULT_CONFIG=1📋 Files Added
blueprints/fivem/docker-compose.yml- Main service configuration with mode documentationblueprints/fivem/template.toml- Dokploy template with optional environment variablesblueprints/fivem/README.md- Comprehensive setup guide for both modesblueprints/fivem/logo.svg- FiveM template logometa.json- Added template metadata entry🧪 Testing
🚨 Key Design Decisions
📚 Related Links
🏷️ Tags
gaming,gta,multiplayer,server