Skip to content

Commit f4f945d

Browse files
committed
Translate and update installation guides
- Fully translated backend installation guides into English (Linux, Windows, and general setup). - Updated formatting, examples, and prompts for clarity. - Replaced outdated Russian sections with English equivalents while preserving technical details.
1 parent 9c5e3a8 commit f4f945d

5 files changed

Lines changed: 96 additions & 99 deletions

File tree

docs/gml-launcher/backend/index.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@
22
sidebar_position: 5
33
---
44

5-
# Серверная часть
5+
# Server Side
66

77
import {DocsCardList} from "@site/src/components/DocsCard";
88
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
99

10-
<DocsCardList list={useCurrentSidebarCategory().items} />
10+
<DocsCardList list={useCurrentSidebarCategory().items} />
11+
```
12+
13+
Здесь заголовок переведен как `Server Side`, а код оставлен без изменений, так как он не требует перевода.
14+
15+
Если хочешь, могу сразу сделать перевод всех заголовков в документации в «чистый» английский стиль для технической документации.

docs/gml-launcher/backend/installation/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
sidebar_position: 1
33
---
44

5-
# Установка
5+
# Installation
66

77
import {DocsCardList} from "@site/src/components/DocsCard";
88
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
99

10-
<DocsCardList list={useCurrentSidebarCategory().items} />
10+
<DocsCardList list={useCurrentSidebarCategory().items} />

docs/gml-launcher/backend/installation/install-linux.md

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -4,78 +4,78 @@ sidebar_position: 1
44

55
# GNU/Linux
66

7-
Это руководство поможет вам установить серверный компонент Gml.Backend на системы GNU/Linux. Установочный
8-
скрипт автоматически настроит все необходимые компоненты для вас.
7+
This guide will help you install the Gml.Backend server component on GNU/Linux systems.
8+
The installation script will automatically configure all necessary components for you.
99

10-
## Предварительные требования
10+
## Prerequisites
1111

12-
Перед началом установки убедитесь, что у вас есть:
12+
Before starting the installation, make sure you have:
1313

14-
- Система GNU/Linux с системой инициализации systemd
15-
- Доступ к терминалу с правами администратора (sudo)
16-
- Интернет-соединение для загрузки установочных файлов
14+
- A GNU/Linux system with the systemd init system
15+
- Terminal access with administrative privileges (sudo)
16+
- An internet connection to download installation files
1717

18-
### Официально протестированные дистрибутивы
18+
### Officially Tested Distributions
1919

20-
Серверная часть должна работать на большинстве современных дистрибутивов GNU/Linux, но официальный скрипт установки, представленный здесь, ограничен в возможных дистрибутивах. Вот список официально протестированных дистрибутивов и их поддержка:
20+
The server component should work on most modern GNU/Linux distributions, but the official installation script provided here supports only certain distributions. Below is a list of officially tested distributions and their support status:
2121

22-
-Полностью поддерживается
23-
- ⚠️ Должно работать, но не тестировалось
24-
-Не поддерживается, используйте [ручную установку](install-source)
22+
-Fully supported
23+
- ⚠️ Should work, but not tested
24+
-Not supported, use [manual installation](install-source)
2525

26-
| Дистрибутив | Версии |
27-
| ------------ | ------ |
28-
| `Ubuntu` | 25 ✅ 24 ⚠️ 22 ⚠️ |
29-
| `Debian` | 13 ✅ 12 ⚠️ |
30-
| `Fedora` | 42 ✅ 41 ⚠️ |
31-
| `Rocky` | 9 |
32-
| `Arch Linux` | ⚠️ |
33-
| `Alpine` | |
26+
| Distribution | Versions |
27+
| ------------- | -------- |
28+
| `Ubuntu` | 25 ✅ 24 ⚠️ 22 ⚠️ |
29+
| `Debian` | 13 ✅ 12 ⚠️ |
30+
| `Fedora` | 42 ✅ 41 ⚠️ |
31+
| `Rocky` | 9 |
32+
| `Arch Linux` | ⚠️ |
33+
| `Alpine` ||
3434

35-
## Шаги установки
35+
## Installation Steps
3636

37-
### Шаг 1: Загрузка установочного скрипта
37+
### Step 1: Download the Installation Script
3838

39-
Откройте терминал и выполните следующую команду для загрузки установочного скрипта:
39+
Open a terminal and run the following command to download the installation script:
4040

4141
```bash
4242
curl -O https://raw.githubusercontent.com/Gml-Launcher/Gml.Backend.Installer/refs/heads/master/installer.sh
43-
```
43+
````
4444

45-
Эта команда загружает установочный скрипт из репозитория GitHub.
45+
This command downloads the installation script from the GitHub repository.
4646

47-
### Шаг 2: Сделайте скрипт исполняемым
47+
### Step 2: Make the Script Executable
4848

49-
После загрузки скрипта вам нужно сделать его исполняемым, выполнив:
49+
After downloading the script, make it executable by running:
5050

5151
```bash
5252
chmod +x ./installer.sh
5353
```
5454

55-
Эта команда дает скрипту разрешение на запуск в вашей системе.
55+
This command grants the script permission to run on your system.
5656

57-
### Шаг 3: Запустите установку
57+
### Step 3: Run the Installation
5858

59-
Теперь вы можете начать установку, выполнив:
59+
Now you can start the installation by executing:
6060

6161
```bash
6262
./installer.sh --version v2025.3.2
6363
```
6464

65-
Скрипт проведет вас через процесс установки с подсказками на русском языке. Следуйте инструкциям на экране для
66-
завершения настройки.
65+
The script will guide you through the installation process with prompts in Russian. Follow the on-screen instructions to complete the setup.
66+
67+
## Troubleshooting
6768

68-
## Устранение неполадок
69+
If you encounter issues during installation:
6970

70-
Если у вас возникли проблемы во время установки:
71+
* Make sure you have an active internet connection
72+
* Verify that you have administrative privileges (try running with sudo if necessary)
73+
* Check for correct command input
74+
* If the script fails to download, you can manually download it from the [GitHub repository](https://github.com/GamerVII-NET/Gml.Backend.Installer)
7175

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

78-
## Дополнительная информация
78+
For more information or to report issues, visit the GitHub repository:
79+
[Gml.Backend.Installer](https://github.com/GamerVII-NET/Gml.Backend.Installer)
7980

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

docs/gml-launcher/backend/installation/install-source.mdx

Lines changed: 36 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -2,45 +2,37 @@
22
sidebar_position: 3
33
---
44

5-
# Прочие системы
5+
# Other Systems
66

7-
Инструкции по установке и настройке серверной части проекта для прочих операционных систем, не имеющих установщика
7+
Instructions for installing and configuring the server component of the project on other operating systems that do not have an installer.
88

9-
## Клонирование репозитория
9+
## Cloning the Repository
1010

11-
Выполните следующую команду в вашем терминале:
11+
Run the following command in your terminal:
1212

1313
```
14-
git clone --recursive -b v2025.3.2 https://github.com/GamerVII-NET/Gml.Backend.git
15-
```
16-
17-
## Переход в директорию проекта
1814
19-
Выполните следующую команду в вашем терминале:
15+
git clone --recursive -b v2025.3.2 [https://github.com/GamerVII-NET/Gml.Backend.git](https://github.com/GamerVII-NET/Gml.Backend.git)
2016
21-
```bash
22-
cd Gml.Backend
23-
```
17+
````
2418
25-
#### Настройка config файла
19+
## Navigate to the Project Directory
2620
27-
Отредактируйте или создайте файл `.env` в корне папки `Gml.Backend`
21+
Run the following command in your terminal:
2822
29-
:::info
30-
Обязательно замените SECURITY_KEY!
31-
32-
Для его генерации можно воспользоваться следующей командой:
3323
```bash
34-
openssl rand -hex 32
35-
```
24+
cd Gml.Backend
25+
````
26+
27+
#### Config File Setup
3628
37-
:::
29+
Edit or create a `.env` file in the root of the `Gml.Backend` folder.
3830
3931
```yaml
40-
# Пример уже настроенного .env
32+
# Example of a pre-configured .env
4133
42-
# UID (User Identifier) и GID (Group Identifier) используется
43-
# для указания id пользователя и группы в Linux.
34+
# UID (User Identifier) and GID (Group Identifier) are used
35+
# to specify the user and group ID in Linux.
4436
UID=0
4537
GID=0
4638
@@ -50,49 +42,49 @@ PROJECT_DESCRIPTION=
5042
PROJECT_POLICYNAME=GmlServerPolicy
5143
PROJECT_PATH=
5244
53-
# Включить подключение к S3
45+
# Enable S3 connection
5446
S3_ENABLED=true
55-
# root пользователь панели управления
47+
# Admin user for the control panel
5648
MINIO_ROOT_USER=GamerVII
57-
# root пароль панели управления
49+
# Admin password for the control panel
5850
MINIO_ROOT_PASSWORD=waefawegferyjerthdrthrtrdthdr
5951
60-
# Включить Swagger
52+
# Enable Swagger
6153
SWAGGER_ENABLED=true
6254
63-
# Настройки внешнего доступа
64-
# Порты, на которых будут работать приложения
65-
# адрес консоли (:5009 или 10.2.0.1:5009)
55+
# External access settings
56+
# Ports for applications
57+
# Console address (:5009 or 10.2.0.1:5009)
6658
MINIO_ADDRESS=:5009
67-
# Порт консоли (совпадает с записью выше)
59+
# Console port (matches the address above)
6860
MINIO_ADDRESS_PORT=5009
69-
# адрес панели (:5010 или 10.2.0.1:5010)
61+
# Panel address (:5010 or 10.2.0.1:5010)
7062
MINIO_CONSOLE_ADDRESS=:5010
71-
# Порт (совпадает с записью выше)
63+
# Port (matches the address above)
7264
MINIO_CONSOLE_ADDRESS_PORT=5010
73-
# Web Api
65+
# Web API
7466
PORT_GML_BACKEND=5000
75-
# Панель управления проектом
67+
# Project management panel
7668
PORT_GML_FRONTEND=5003
77-
# Файловый сервис
69+
# File service
7870
PORT_GML_FILES=5005
79-
# Сервис скинов
71+
# Skins service
8072
PORT_GML_SKINS=5006
8173
82-
# Микросервисы:
74+
# Microservices:
8375
SERVICE_TEXTURE_ENDPOINT=http://gml-web-skins:8085
8476
MARKET_ENDPOINT=https://gml-market.recloud.tech
8577
```
8678

87-
#### Запуск проекта с использованием Docker
79+
#### Running the Project with Docker
8880

89-
Выполните следующую команду в вашем терминале:
81+
Run the following command in your terminal:
9082

9183
```bash
9284
docker compose up -f ./docker-compose-prod.yml -d
9385
```
9486

95-
Пожалуйста, убедитесь, что Docker установлен и работает на вашем компьютере/сервере для выполнения этой команды.
87+
Please make sure Docker is installed and running on your computer/server to execute this command.
9688

97-
После выполнения команды Docker загрузит необходимые образы и запустит проект.
98-
После запуска проекта, вы сможете открыть его в браузере, используя адрес `http://<ip_вашего_сервера>:5003`.
89+
After running the command, Docker will pull the required images and start the project.
90+
Once the project is running, you can access it in your browser using `http://<your_server_ip>:5003`.

docs/gml-launcher/backend/installation/install-windows.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@ sidebar_position: 2
55
---
66

77
:::info
8-
Перед началом установки, убедитесь что у вас установлены следующие программы:
8+
Before starting the installation, make sure you have the following programs installed:
99

10-
- WSL ([Инструкция](https://learn.microsoft.com/ru-ru/windows/wsl/install))
11-
- Git ([Официальный сайт](https://git-scm.com/))
12-
- Docker ([Официальный сайт](https://www.docker.com/products/docker-desktop/))
10+
- WSL ([Guide](https://learn.microsoft.com/en-us/windows/wsl/install))
11+
- Git ([Official website](https://git-scm.com/))
12+
- Docker ([Official website](https://www.docker.com/products/docker-desktop/))
1313
:::
1414

15-
## Скачайте файл установщика
15+
## Download the Installer File
1616

17-
Скачайте файл установщика:
18-
[Перейти к файлу](https://github.com/Gml-Launcher/Gml.Backend.Installer/blob/master/windows64-installer.bat)
17+
Download the installer file:
18+
[Go to the file](https://github.com/Gml-Launcher/Gml.Backend.Installer/blob/master/windows64-installer.bat)
1919

20-
Создайте папку в удобном для вас месте, переместите туда скачайнный bat файл и запустите.
20+
Create a folder in a convenient location, move the downloaded `.bat` file there, and run it.
2121

22-
Запустите установщик от имени администратора и дождитесь окончания установки
22+
Run the installer as an administrator and wait until the installation is complete.

0 commit comments

Comments
 (0)