Other Systems

Instructions for installing and configuring the server component of the project for other operating systems that do not have an installer.

Development and stable installation

To run the source with Rider or scripts/dev.sh, follow the local development guide. The API creates a development key automatically on first launch.

The commands below run Docker images tagged master. For a stable release, use Gml Manager. For production, provide your own SECURITY_KEY through the environment; replace <your-security-key> with the output of openssl rand -hex 32.

Cloning the Repository

Run the following command in your terminal:

git clone --recursive -b master https://github.com/Gml-Launcher/Gml.Backend.git

Navigate to the Project Directory

Run the following command in your terminal:

cd Gml.Backend

Config File Setup

Edit or create a .env file in the root of the Gml.Backend folder.

信息

Make sure to replace SECURITY_KEY!

To generate it, you can use the following command:

openssl rand -hex 32

# Example of a pre-configured .env

# UID (User Identifier) and GID (Group Identifier) are used
# to specify the user and group ID in Linux.
UID=0
GID=0

SECURITY_KEY=<your-security-key>
PROJECT_NAME=GmlBackendPanel
PROJECT_DESCRIPTION=
PROJECT_POLICYNAME=GmlServerPolicy
PROJECT_PATH=

# Enable Swagger
SWAGGER_ENABLED=true

# External access settings
# Ports for applications
# Project management panel
PORT_GML_FRONTEND=5003

# Microservices:
SERVICE_TEXTURE_ENDPOINT=http://gml-web-skins:8085
MARKET_ENDPOINT=https://gml-market.recloud.tech

Running the Project with Docker

Run the following command in your terminal:

docker compose -f ./docker-compose-prod.yml up -d

Please make sure Docker is installed and running on your computer/server to execute this command.

After running the command, Docker will pull the required images and start the project. Once the project is running, you can access it in your browser using http://<your_server_ip>:5003.