[PR #393] [MERGED] Add FiveM server template with dual deployment modes #424

New Issue

GiteaMirror · 2025-11-22T20:38:19-06:00

GiteaMirror commented

2025-11-22 20:38:19 -06:00

📋 Pull Request Information

Original PR: https://github.com/Dokploy/templates/pull/393
Author: @shishirahm3d
Created: 9/23/2025
Status: ✅ Merged
Merged: 9/27/2025
Merged by: @Siumauricio

Base: main ← Head: feat/add-fivem-server

📝 Commits (5)

4f78edf feat: Added fivem server
e8d6989 feat: add FiveM server template with dual deployment modes
bee633e docs: add deployment mode awareness to FiveM docker-compose
8314dfe Added all env variables.
7bcba7f fix: follow Dokploy template.toml format

📊 Changes

4 files changed (+86 additions, -0 deletions)

View changed files

➕ blueprints/fivem/docker-compose.yml (+41 -0)
➕ blueprints/fivem/logo.svg (+10 -0)
➕ blueprints/fivem/template.toml (+17 -0)
📝 meta.json (+18 -0)

📄 Description

📝 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

Docker Compose Configuration: Uses spritsail/fivem image with proper TTY setup
Dual Deployment Modes: Support for both standard server and txAdmin web interface
Comprehensive Documentation: Clear instructions for each deployment mode
Template Configuration: Complete template.toml with environment variable descriptions
Branding: FiveM logo and proper meta.json entry

🎮 Features

✅ Standard FiveM Server: Direct deployment with license key environment variable
✅ txAdmin Web Interface: Web-based server management and configuration
✅ HTTPS Support: Automatic SSL through Dokploy for web interface
✅ Persistent Storage: Volumes for server config and txAdmin data
✅ Proper Port Mapping: Game server (30120) and web UI (40120) ports
✅ Interactive Setup: TTY and stdin_open for container requirements

🔧 Deployment Modes

Mode 1: Standard Server

Set LICENSE_KEY environment variable
Direct server deployment
Configuration via mounted files

Mode 2: txAdmin Web Interface

Set NO_DEFAULT_CONFIG=1
License configured via web UI
Web-based server management

📋 Files Added

blueprints/fivem/docker-compose.yml - Main service configuration with mode documentation
blueprints/fivem/template.toml - Dokploy template with optional environment variables
blueprints/fivem/README.md - Comprehensive setup guide for both modes
blueprints/fivem/logo.svg - FiveM template logo
meta.json - Added template metadata entry

🧪 Testing

Docker Compose syntax validated
Template.toml follows Dokploy standards
Meta.json entry properly formatted
Both deployment modes documented
Environment variable conflicts addressed

🚨 Key Design Decisions

Dual Mode Support: Addresses the different ways users deploy FiveM servers
Clear Documentation: Prevents common licensing configuration errors
Optional License Key: Accommodates txAdmin's web-based license setup
Comprehensive Warnings: Prevents mixing deployment modes

🏷️ Tags

gaming, gta, multiplayer, server

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Dokploy/templates/pull/393 **Author:** [@shishirahm3d](https://github.com/shishirahm3d) **Created:** 9/23/2025 **Status:** ✅ Merged **Merged:** 9/27/2025 **Merged by:** [@Siumauricio](https://github.com/Siumauricio) **Base:** `main` ← **Head:** `feat/add-fivem-server` --- ### 📝 Commits (5) - [`4f78edf`](https://github.com/Dokploy/templates/commit/4f78edf90089006410b8b635e3dd2415fd29a378) feat: Added fivem server - [`e8d6989`](https://github.com/Dokploy/templates/commit/e8d6989616377675aee2b03db8fea7b95f9457fd) feat: add FiveM server template with dual deployment modes - [`bee633e`](https://github.com/Dokploy/templates/commit/bee633e33d0aaaef743ff247a3a4f5b7de218cb1) docs: add deployment mode awareness to FiveM docker-compose - [`8314dfe`](https://github.com/Dokploy/templates/commit/8314dfe6538fa6ddc15de392b9dbc60963681fa9) Added all env variables. - [`7bcba7f`](https://github.com/Dokploy/templates/commit/7bcba7fea665a4c34d6dd932e03e31622b1a07f0) fix: follow Dokploy template.toml format ### 📊 Changes **4 files changed** (+86 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `blueprints/fivem/docker-compose.yml` (+41 -0) ➕ `blueprints/fivem/logo.svg` (+10 -0) ➕ `blueprints/fivem/template.toml` (+17 -0) 📝 `meta.json` (+18 -0) </details> ### 📄 Description ## 📝 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 - **Docker Compose Configuration**: Uses spritsail/fivem image with proper TTY setup - **Dual Deployment Modes**: Support for both standard server and txAdmin web interface - **Comprehensive Documentation**: Clear instructions for each deployment mode - **Template Configuration**: Complete template.toml with environment variable descriptions - **Branding**: FiveM logo and proper meta.json entry ## 🎮 Features - ✅ **Standard FiveM Server**: Direct deployment with license key environment variable - ✅ **txAdmin Web Interface**: Web-based server management and configuration - ✅ **HTTPS Support**: Automatic SSL through Dokploy for web interface - ✅ **Persistent Storage**: Volumes for server config and txAdmin data - ✅ **Proper Port Mapping**: Game server (30120) and web UI (40120) ports - ✅ **Interactive Setup**: TTY and stdin_open for container requirements ## 🔧 Deployment Modes ### **Mode 1: Standard Server** - Set `LICENSE_KEY` environment variable - Direct server deployment - Configuration via mounted files ### **Mode 2: txAdmin Web Interface** - Set `NO_DEFAULT_CONFIG=1` - License configured via web UI - Web-based server management ## 📋 Files Added - `blueprints/fivem/docker-compose.yml` - Main service configuration with mode documentation - `blueprints/fivem/template.toml` - Dokploy template with optional environment variables - `blueprints/fivem/README.md` - Comprehensive setup guide for both modes - `blueprints/fivem/logo.svg` - FiveM template logo - `meta.json` - Added template metadata entry ## 🧪 Testing - [x] Docker Compose syntax validated - [x] Template.toml follows Dokploy standards - [x] Meta.json entry properly formatted - [x] Both deployment modes documented - [x] Environment variable conflicts addressed ## 🚨 Key Design Decisions - **Dual Mode Support**: Addresses the different ways users deploy FiveM servers - **Clear Documentation**: Prevents common licensing configuration errors - **Optional License Key**: Accommodates txAdmin's web-based license setup - **Comprehensive Warnings**: Prevents mixing deployment modes ## 📚 Related Links - [FiveM Official Website](https://fivem.net/) - [FiveM Server Documentation](https://docs.fivem.net/docs/server-manual/) - [txAdmin Documentation](https://github.com/citizenfx/txAdmin/blob/master/README.md) - [Docker Image Source](https://github.com/spritsail/fivem) ## 🏷️ Tags `gaming`, `gta`, `multiplayer`, `server` --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2025-11-22 20:38:19 -06:00

GiteaMirror closed this issue

2025-11-22 20:38:19 -06:00

GiteaMirror referenced this issue

2025-11-22 20:38:51 -06:00

[PR #424] [MERGED] Add Storyden blueprint and meta #448

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/templates#424