diff --git a/docs/basic/auth.md b/docs/basic/auth.md index e4eba3d..a14fa65 100644 --- a/docs/basic/auth.md +++ b/docs/basic/auth.md @@ -40,12 +40,12 @@ auth: ```hjson auth: { + type: json authUrl: http://example.com/auth joinUrl: http://example.com/join - hasJoinedUrl: http://example.com/hasJoin + hasJoinedUrl: http://example.com/hasJoined profileUrl: http://example.com/profile profilesUrl: http://example.com/profiles - type: json } ``` @@ -58,6 +58,7 @@ auth: ```hjson auth: { + type: db connection: { type: mysql host: 127.0.0.1 @@ -76,7 +77,6 @@ auth: skinUrlColumn: skinURL capeUrlColumn: capeURL } - type: db } ``` diff --git a/docs/basic/install-launch-server.md b/docs/basic/install-launch-server.md index 73b6d93..358ffcd 100644 --- a/docs/basic/install-launch-server.md +++ b/docs/basic/install-launch-server.md @@ -19,8 +19,8 @@ ```hjson { configVersion: 0 - projectID: c83f8c24-6207-45ce-8df4-671f2cb9e137 - projectName: "" + projectID: 00000000-0000-0000-0000-000000000000 + projectName: "Example Project" lang: ru branch: stable env: dev @@ -60,12 +60,13 @@ `mirrors` - список зеркал, для скачивания файлов игры. Для получения подробной информации смотрите раздел [Загрузка клиентов](clients.md) `auth` - блок настроек методов авторизации и получения скинов, подробнее в разделе [Настройка авторизации](auth.md) `api` - блок настроек подключения к лаунчсерверу. Содержит следующие настройки: + - `host` - внутренный IP, с которого лаунчсервер будет слушать запросы. Не трогать, если не знаете что это и как работает - `port` - порт, который будет слушать лаунчсервер. Аналогично предыдущему пункту - `disableListing` - Включить отдачу папок и файлов силами лаунчсервера, рекомендуется отключать при проксировании файлов, например через [Nginx](nginx.md) - `hideListing` - Отключить вывод списка папок и файлов, не работает если `disableListing` установлен в значении `true` - `useSSL` - Использовать SSL сертификат для сервера. При использовании сертификата не забудьте поменять в `address` url с `ws` на `wss` -- `ssl` - пути для используемых файлов сертификата в PEM формате. Можно указывать как абсолютный так и относительный (из директории в которой был запущен лаунчсервер) путь до файлов. Подробнее о параметрах [cert и key](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options) +- `ssl` - пути для используемых файлов сертификата в PEM формате. Можно указывать как абсолютный так и относительный (из директории в которой был запущен лаунчсервер) путь до файлов. Подробнее о параметрах [cert и key](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options) - `skinDomains` - Список адресов для загрузки скинов, подробнее в разделе [Настройка системы скинов](system-skin.md) Для работы с защищённым подключением с использованием SSL сертификата рекомендуется вместо настройки `ssl` в лаунчсервере использовать проксирование сервера через [Nginx](nginx.md). Данный подход позволяет более удобно настраивать подключение (например с использованием автоматизированных скриптов certbot-a), а также переложить часть нагрузки с Node.js сервера на [Nginx](nginx.md).