Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 52 additions & 43 deletions docs/gml-launcher/backend/installation/install-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,76 +4,85 @@ sidebar_position: 1

# GNU/Linux

This guide will help you install the Gml.Backend server component on GNU/Linux systems. The installation script will automatically configure all the necessary components for you.
This guide will help you install the Gml.Backend server component on a GNU/Linux system.

## Prerequisites

Before starting the installation, make sure you have:

- A GNU/Linux system with the systemd init system
- Access to a terminal with administrative privileges (sudo)
- An internet connection to download the installation files
- a GNU/Linux system;
- access to a terminal with administrator privileges;
- an internet connection.

### Officially Tested Distributions
## Installation with Gml Manager

The server side should work on most modern GNU/Linux distributions, but the official installation script presented here is limited in the distributions it supports. Here is a list of officially tested distributions and their support status:
Gml Manager is an interactive script for installing, updating, and removing Gml.Backend. By default, it uses the latest stable version and installs the project in `/srv/gml`.

- ✅ Fully supported
- ⚠️ Should work but has not been tested
- ❌ Not supported, use [manual installation](install-source)
The following distributions and their derivatives are officially supported: Debian, Ubuntu, Fedora, Alpine Linux, and Arch Linux. For other distributions, use the [manual installation](install-source) instructions.

| Distribution | Versions |
| ------------ | -------- |
| `Ubuntu` | 25 ✅ 24 ⚠️ 22 ⚠️ |
| `Debian` | 13 ✅ 12 ⚠️ |
| `Fedora` | 42 ✅ 41 ⚠️ |
| `Rocky` | 9 ✅ |
| `Arch Linux` | ⚠️ |
| `Alpine` | ❌ |
Run the installation manager:

## Installation Steps
```bash
curl -sSL https://raw.githubusercontent.com/Gml-Launcher/Gml.Backend/refs/heads/master/installer/gml-manager.sh | sudo sh
```

### Step 1: Downloading the Installation Script
The manager will prompt you to choose an action (installation, update, or removal), the installation directory, and the project version.

Open a terminal and run the following command to download the installation script:
If you are already running as `root`, run the command without `sudo`:

```bash
curl -O https://raw.githubusercontent.com/Gml-Launcher/Gml.Backend.Installer/refs/heads/master/installer.sh
````
curl -sSL https://raw.githubusercontent.com/Gml-Launcher/Gml.Backend/refs/heads/master/installer/gml-manager.sh | sh
```

### Non-interactive installation

This command downloads the installation script from the GitHub repository.
To install the project in a specified directory without additional prompts, pass the parameters through `sh -s --`:

### Step 2: Make the Script Executable
```bash
curl -sSL https://raw.githubusercontent.com/Gml-Launcher/Gml.Backend/refs/heads/master/installer/gml-manager.sh | sudo sh -s -- install --dir /srv/gml
```

After the script is downloaded, you need to make it executable by running:
Specify `--version` only if you want to pin a specific Docker image tag:

```bash
chmod +x ./installer.sh
````
curl -sSL https://raw.githubusercontent.com/Gml-Launcher/Gml.Backend/refs/heads/master/installer/gml-manager.sh | sudo sh -s -- install --version v2025.3.2 --dir /srv/gml
```

This command gives the script permission to run on your system.
### Updating and removing

### Step 3: Run the Installation
To update or remove the project, run the corresponding command or start the installation manager and select the required action:

Now you can start the installation by running:
```bash
curl -sSL https://raw.githubusercontent.com/Gml-Launcher/Gml.Backend/refs/heads/master/installer/gml-manager.sh | sudo sh -s -- update --dir /srv/gml
```

```bash
./installer.sh --version v2025.3.2
````
curl -sSL https://raw.githubusercontent.com/Gml-Launcher/Gml.Backend/refs/heads/master/installer/gml-manager.sh | sudo sh -s -- delete --dir /srv/gml
```

The script will guide you through the installation process with prompts in Russian. Follow the on-screen instructions to complete the setup.
### Compatibility with the legacy installer

## Troubleshooting
If you previously installed the project using the [legacy installer](https://github.com/Gml-Launcher/Gml.Backend.Installer), you can use Gml Manager to update it. Select the `update` action and specify the directory where the project was installed.

## Manual installation

If you encounter problems during the installation:
If Gml Manager is not suitable for your system, follow the [manual installation](install-source) instructions.

## Services after installation

- **Web API:** `http://<your_host>:5000` — the main service;
- **Web Dashboard:** `http://<your_host>:5003` — the monitoring and administration panel;
- **Gml.Web.Skin.Service:** `http://<your_host>:5006` — the service for managing player textures and personalization.

You can change the addresses and ports in the project settings.

## Troubleshooting

- Make sure you have an internet connection
- Check that you have administrative rights (try running with sudo if necessary)
- Check that the commands are entered correctly
- If the script fails to download, you can download it manually
from the [GitHub repository](https://github.com/GamerVII-NET/Gml.Backend.Installer)
If you encounter problems during installation:

## Additional Information
- check your internet connection;
- make sure Docker Hub and GitHub are accessible (for example, run `wget get.docker.com` and `wget raw.githubusercontent.com`);
- check that you have administrator privileges;
- make sure the specified installation directory is writable and empty.

For more information or to report issues, visit the
GitHub repository: [Gml.Backend.Installer](https://github.com/GamerVII-NET/Gml.Backend.Installer)
For more information, visit the [Gml.Backend repository](https://github.com/Gml-Launcher/Gml.Backend).
15 changes: 0 additions & 15 deletions docs/gml-launcher/backend/installation/install-source.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,26 +49,11 @@ PROJECT_DESCRIPTION=
PROJECT_POLICYNAME=GmlServerPolicy
PROJECT_PATH=

# Enable S3 connection
S3_ENABLED=true
# Admin user for the control panel
MINIO_ROOT_USER=GamerVII
# Admin password for the control panel
MINIO_ROOT_PASSWORD=waefawegferyjerthdrthrtrdthdr

# Enable Swagger
SWAGGER_ENABLED=true

# External access settings
# Ports for applications
# Console address (:5009 or 10.2.0.1:5009)
MINIO_ADDRESS=:5009
# Console port (matches the address above)
MINIO_ADDRESS_PORT=5009
# Panel address (:5010 or 10.2.0.1:5010)
MINIO_CONSOLE_ADDRESS=:5010
# Port (matches the address above)
MINIO_CONSOLE_ADDRESS_PORT=5010
# Web API
PORT_GML_BACKEND=5000
# Project management panel
Expand Down
8 changes: 0 additions & 8 deletions docs/gml-launcher/backend/security/base.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,6 @@
```yaml
# Настройки внешнего доступа
# Порты, на которых будут работать приложения
# адрес консоли (:5009 или 10.2.0.1:5009)
MINIO_ADDRESS=:5009
# Порт консоли (совпадает с записью выше)
MINIO_ADDRESS_PORT=5009
# адрес панели (:5010 или 10.2.0.1:5010)
MINIO_CONSOLE_ADDRESS=:5010
# Порт (совпадает с записью выше)
MINIO_CONSOLE_ADDRESS_PORT=5010
# Web Api
PORT_GML_BACKEND=5000
# Панель управления проектом
Expand Down
5 changes: 0 additions & 5 deletions docs/gml-launcher/faq/popular.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,6 @@ You need to download the launcher’s dependent projects.
In the project root, there are bat and sh files to run depending on your operating system.
If nothing happens or the console closes immediately, check if [Git version control](https://git-scm.com) is installed.

## Minio Not Working

Minio may fail if a too-simple password was set during installation.
Change it in the `.env` file and restart the project with `docker compose restart`.

## Connecting Discord

To connect Discord to your launcher,
Expand Down
14 changes: 7 additions & 7 deletions docs/gml-launcher/system-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ Before installing Gml, make sure your system meets the following requirements:

## Server Hardware Requirements

| Parameter | Specification |
|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
| Operating System | Windows, macOS, Linux (with [Docker](https://www.docker.com) support) |
| RAM | At least 4096 MB for running<br/><br/> ~512 MB for operation |
| CPU Cores | 1 or more |
| Disk Space | 4 GB – Control Panel + Backend<br/>4 GB – per game profile<br/>8–10 GB – Launcher Builder + Game Profile Builder |
| Docker Installation | Required |
| Parameter | Specification |
| ------------------- | ---------------------------------------------------------------------------------------------------------------- |
| Operating System | Windows, macOS, Linux (with [Docker](https://www.docker.com) support) |
| RAM | At least 2048 MB for running<br/><br/> ~512 MB for operation (4+GB for launcher building function) |
| CPU Cores | 1 or more |
| Disk Space | 4 GB – Control Panel + Backend<br/>4 GB – per game profile<br/>8–10 GB – Launcher Builder + Game Profile Builder |
| Docker Installation | Required |
Original file line number Diff line number Diff line change
Expand Up @@ -4,78 +4,85 @@ sidebar_position: 1

# GNU/Linux

Это руководство поможет вам установить серверный компонент Gml.Backend на системы GNU/Linux. Установочный
скрипт автоматически настроит все необходимые компоненты для вас.
Это руководство поможет установить серверную часть Gml.Backend в системе GNU/Linux.

## Предварительные требования

Перед началом установки убедитесь, что у вас есть:

- Система GNU/Linux с системой инициализации systemd
- Доступ к терминалу с правами администратора (sudo)
- Интернет-соединение для загрузки установочных файлов
- система GNU/Linux;
- доступ к терминалу с правами администратора;
- подключение к интернету;

### Официально протестированные дистрибутивы
## Установка через Gml Manager

Серверная часть должна работать на большинстве современных дистрибутивов GNU/Linux, но официальный скрипт установки, представленный здесь, ограничен в возможных дистрибутивах. Вот список официально протестированных дистрибутивов и их поддержка:
Gml Manager — интерактивный скрипт для установки, обновления и удаления Gml.Backend. По умолчанию он использует последнию стабильную версию и устанавливает проект в `/srv/gml`.

- ✅ Полностью поддерживается
- ⚠️ Должно работать, но не тестировалось
- ❌ Не поддерживается, используйте [ручную установку](install-source)
Официально поддерживаются следующие дистрибутивы: Debian, Ubuntu, Fedora, Alpine Linux, Arch Linux и их производные. Для других дистрибутивов используйте [ручную установку](install-source).

| Дистрибутив | Версии |
| ------------ | ------ |
| `Ubuntu` | 25 ✅ 24 ⚠️ 22 ⚠️ |
| `Debian` | 13 ✅ 12 ⚠️ |
| `Fedora` | 42 ✅ 41 ⚠️ |
| `Rocky` | 9 ✅ |
| `Arch Linux` | ⚠️ |
| `Alpine` | ❌ |
Запустите менеджер установки:

## Шаги установки
```bash
curl -sSL https://raw.githubusercontent.com/Gml-Launcher/Gml.Backend/refs/heads/master/installer/gml-manager.sh | sudo sh
```

### Шаг 1: Загрузка установочного скрипта
Менеджер предложит выбрать действие (установка, обновление, удаление), директорию установки и версию проекта.

Откройте терминал и выполните следующую команду для загрузки установочного скрипта:
Если вы уже работаете от имени `root`, выполните команду без `sudo`:

```bash
curl -O https://raw.githubusercontent.com/Gml-Launcher/Gml.Backend.Installer/refs/heads/master/installer.sh
curl -sSL https://raw.githubusercontent.com/Gml-Launcher/Gml.Backend/refs/heads/master/installer/gml-manager.sh | sh
```

Эта команда загружает установочный скрипт из репозитория GitHub.
### Установка без интерактивных запросов

### Шаг 2: Сделайте скрипт исполняемым
Чтобы установить проект в указанную директорию без дополнительных вопросов, передайте параметры через `sh -s --`:

После загрузки скрипта вам нужно сделать его исполняемым, выполнив:
```bash
curl -sSL https://raw.githubusercontent.com/Gml-Launcher/Gml.Backend/refs/heads/master/installer/gml-manager.sh | sudo sh -s -- install --dir /srv/gml
```

Указывайте `--version` только в том случае, если хотите закрепить определённый тег Docker-образов:

```bash
chmod +x ./installer.sh
curl -sSL https://raw.githubusercontent.com/Gml-Launcher/Gml.Backend/refs/heads/master/installer/gml-manager.sh | sudo sh -s -- install --version v2025.3.2 --dir /srv/gml
```

Эта команда дает скрипту разрешение на запуск в вашей системе.
### Обновление и удаление

### Шаг 3: Запустите установку
Для обновления или удаления проекта выполните соответствующую команду или запустите менеджер установки и выберите нужное действие:

Теперь вы можете начать установку, выполнив:
```bash
curl -sSL https://raw.githubusercontent.com/Gml-Launcher/Gml.Backend/refs/heads/master/installer/gml-manager.sh | sudo sh -s -- update --dir /srv/gml
```

```bash
./installer.sh --version v2025.3.2
curl -sSL https://raw.githubusercontent.com/Gml-Launcher/Gml.Backend/refs/heads/master/installer/gml-manager.sh | sudo sh -s -- delete --dir /srv/gml
```

Скрипт проведет вас через процесс установки с подсказками на русском языке. Следуйте инструкциям на экране для
завершения настройки.
### Совместимость со старым установщиком

## Устранение неполадок
Если вы ранее устанавливали с помощью [старого установщика](https://github.com/Gml-Launcher/Gml.Backend.Installer), вы можете использовать Gml Manager для обновления проекта. Для этого выберите действие "обновить" и укажите директорию, в которую был установлен проект.

## Ручная установка

Если Gml Manager не подходит для вашей системы, воспользуйтесь инструкцией по [ручной установке](install-source).

## Сервисы после установки

Если у вас возникли проблемы во время установки:
- **Web API:** `http://<ваш_хост>:5000` — основной сервис;
- **Web Dashboard:** `http://<ваш_хост>:5003` — панель мониторинга и администрирования;
- **Gml.Web.Skin.Service:** `http://<ваш_хост>:5006` — сервис управления текстурами и персонализацией игроков.

Адреса и порты можно изменить в настройках проекта.

## Устранение неполадок

- Убедитесь, что у вас есть подключение к интернету
- Проверьте, что у вас есть права администратора (при необходимости попробуйте запустить с sudo)
- Проверьте правильность ввода команд
- Если скрипт не удается загрузить, вы можете вручную загрузить его
из [репозитория GitHub](https://github.com/GamerVII-NET/Gml.Backend.Installer)
Если во время установки возникли проблемы:

## Дополнительная информация
- проверьте подключение к интернету;
- убедитесь, что есть возможность подключения к Docker Hub и GitHub (например так: `wget get.docker.com`, `wget raw.githubusercontent.com`);
- проверьте наличие прав администратора;
- убедитесь, что указанная директория установки доступна для записи и пуста.

Для получения дополнительной информации или сообщения о проблемах посетите репозиторий
GitHub: [Gml.Backend.Installer](https://github.com/GamerVII-NET/Gml.Backend.Installer)
Для получения дополнительной информации посетите репозиторий [Gml.Backend](https://github.com/Gml-Launcher/Gml.Backend).
Loading
Loading