Первый запуск

Запустите программу

Windows. Дважды щёлкните server.exe. Откроется чёрное окно консоли: не закрывайте его, пока пользуетесь панелью. Windows может показать предупреждение о неизвестной программе. В таком случае нажмите Подробнее → Выполнить в любом случае.

Linux. Откройте терминал в папке с программой и выполните:

chmod +x server
./server

Придумайте мастер-пароль

При первом запуске сервер попросит создать мастер-пароль и повторить его:

Enter Master Password:
Confirm Master Password:

При вводе вместо символов отображаются звёздочки, так и должно быть.

Мастер-паролем шифруются данные ваших аккаунтов, поэтому сервер будет спрашивать его при каждом запуске.

Запишите мастер-пароль в надёжное место. Он нигде не хранится, и восстановить его нельзя. Без него сервер не сможет прочитать сохранённые данные, и аккаунты придётся добавлять заново.

Введите лицензионный ключ

Затем сервер попросит ключ из личного кабинета:

Enter your license key:

Вставьте ключ и нажмите Enter. Вводить его нужно только один раз: при следующих запусках сервер активируется сам.

Откройте панель

Когда в консоли появится строка api listening, сервер готов. Откройте в браузере на том же компьютере:

http://localhost:8080

Первая страница панели

Отдельного входа в панель нет: она сразу открывается. Поэтому прочитайте следующий раздел.

Защитите панель

Панель не спрашивает пароль. Любой, кто откроет её адрес, сможет управлять вашими аккаунтами. Никогда не открывайте порт 8080 в интернет.

По умолчанию сервер принимает подключения со всех сетевых адресов компьютера. Если панель нужна только на этом компьютере, закройте доступ извне:

Остановите сервер (см. ниже).
Откройте config.toml в папке data.
Замените значение api_bind:
```
[network]
api_bind = "127.0.0.1:8080"
```
Запустите сервер снова.

Если сервер стоит на VPS, сделайте то же самое и подключайтесь к панели через SSH-туннель. Выполните на своём компьютере, подставив свои данные:

ssh -L 8080:127.0.0.1:8080 user@адрес-вашего-vps

Пока это подключение открыто, панель доступна у вас на http://localhost:8080.

Как остановить сервер

Нажмите Ctrl+C в окне консоли и дождитесь завершения. На следующий запуск снова понадобится мастер-пароль.

Что появилось на диске

Рядом с программой создаётся папка data:

Что	Зачем
`server.db` и файлы `server.db-*`	База данных: аккаунты и их секреты в зашифрованном виде
`config.toml`	Настройки сервера
`logs/`	Журналы работы, по файлу на день

Эту папку нужно сохранять при обновлении и переносе.

Запуск без участия человека

Этот раздел нужен, если сервер должен стартовать сам, например на VPS. Режим --headless отключает все вопросы в консоли, поэтому пароль и ключ нужно передать заранее.

Параметр	Что делает
`--headless`	Не задавать вопросов в консоли
`--license-key КЛЮЧ`	Передать лицензионный ключ. Нужен только для первой активации
`SERVER_MASTER_PASS`	Переменная окружения с мастер-паролем
`--key-file ПУТЬ`	Или файл, в котором записан мастер-пароль
`--data-dir ПУТЬ`	Папка с данными. По умолчанию `data` в текущей папке

Пример службы systemd для Linux, файл /etc/systemd/system/yaam.service:

[Unit]
Description=YA:AM server
After=network-online.target
Wants=network-online.target

[Service]
ExecStart=/opt/yaam/server --headless --data-dir /opt/yaam/data
EnvironmentFile=/opt/yaam/secret.env
Restart=on-failure

[Install]
WantedBy=multi-user.target

В /opt/yaam/secret.env запишите пароль и закройте файл от других пользователей (chmod 600):

SERVER_MASTER_PASS=ваш-мастер-пароль

Перед первым запуском службы один раз активируйте лицензию вручную, передав те же параметры и --license-key. Затем включите службу:

sudo systemctl enable --now yaam

Дальше: обзор панели.

Keyboard shortcuts

Гайд YA:AM