Установка через Docker Compose

Создайте рабочую директорию и скачайте конфигурацию

Выполните на сервере:

mkdir /opt/yonote
cd /opt/yonote
curl -O https://yonote.ru/onprem/yonote-onprem.zip
unzip yonote-onprem.zip
cd yonote-onprem

Можно выбрать любой каталог, в примерах используется /opt/yonote. Архив распаковывается в папку yonote-onprem: все следующие команды выполняйте из неё.

Если с сервера нет доступа к yonote.ru, скачайте архив здесь, загрузите его на сервер любым удобным способом и выполните unzip:

В архиве лежат docker-compose.yml, шаблон настроек .env.sample (скрытый файл, виден по ls -a), конфигурация nginx и скрипт инициализации базы Keycloak.

Выберите версию

Список доступных версий: images.updates.yonote.ru/v2/yonote/tags/list. Укажите выбранную версию в APP_VERSION (в шаблоне стоит 1.45.33). Версию latest лучше не использовать: так вы сами решаете, когда обновляться.

Создайте .env

Скопируйте шаблон и откройте его в редакторе:

cp .env.sample .env
vim .env

Обязательно заполните:

• домены: замените domain.ru на свой домен в BASENAME_FOR_SUBDOMAIN, KC_YNT_HOST и S3_YNT_HOST. Адрес S3_ADMIN_YNT_HOST (веб-консоль хранилища) по желанию;
• пароли: YNT_DB_PASSWORD, KC_DB_PASSWORD, KC_PASSWORD, S3_ADMIN_PASSWORD и S3_SECRET_ACCESS_KEY. В шаблоне стоят примеры, смените их;
• LICENSE_KEY: вставьте содержимое лицензии одной строкой, без кавычек и пробелов. Если лицензии нет, получите триал за 5 минут (лицензия выпускается автоматически), по вопросам покупки пишите на hello@yonote.ru;
• SECRET_KEY и UTILS_SECRET (следующий шаг);
• блок SMTP_*: заполните, если нужна почта, иначе закомментируйте строки SMTP_* (поставьте #).

Для паролей используйте только буквы и цифры: пароль базы подставляется в адрес подключения, и спецсимволы (@, :, /, #) его сломают.

Назначение каждой переменной описано в разделе Переменные окружения.

Сгенерируйте секреты

SECRET_KEY и UTILS_SECRET нужно сгенерировать и записать в .env:

openssl rand -hex 32

Команду выполните дважды: для SECRET_KEY и для UTILS_SECRET. Значения должны быть разными.

Ключи Web Push (Service Worker) создаются командой (нужен Node.js и npm, можно на любом компьютере):

npx web-push generate-vapid-keys

Результат запишите в .env:

SERVICE_WORKER_PUBLIC_KEY=<ваш публичный ключ>
SERVICE_WORKER_PRIVATE_KEY=<ваш приватный ключ>

Настройте DNS

Адреса из .env (приложение, auth. и s3.) должны открываться и на сервере, и в браузерах пользователей, и указывать на этот сервер. Добавьте записи в DNS (для веб-консоли хранилища по желанию добавьте ещё и s3-admin.). Для проверки без DNS можно прописать их в /etc/hosts (на сервере и на вашем компьютере):

192.0.2.10  domain.ru auth.domain.ru s3.domain.ru

Замените 192.0.2.10 на IP сервера, а домены на свои.

Запустите приложение

docker compose up -d

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

docker compose ps
docker compose logs -f yonote

Приложение готово, когда в логах yonote появились сообщения о запуске сервера, а docker compose ps показывает все сервисы запущенными. Сервис seaweedfs-client отработает (создаст пользователя и бакет в хранилище) и завершится, это нормально.

Настройте планировщик

Уведомления календаря и плановая очистка работают через cron. Добавьте на сервере два задания по инструкции Планировщик задач.

Войдите в систему

Откройте адрес из BASENAME_FOR_SUBDOMAIN, например http://domain.ru, и нажмите вход. На странице авторизации (Keycloak) выберите регистрацию и создайте пользователя. Первый вошедший пользователь создаёт рабочее пространство и становится его администратором, остальных можно пригласить из приложения.

Консоль Keycloak доступна по адресу http://auth.domain.ru (логин и пароль из KC_USERNAME и KC_PASSWORD), при желании можно открыть и веб-консоль хранилища SeaweedFS по адресу из S3_ADMIN_YNT_HOST (логин и пароль из S3_ADMIN_USERNAME и S3_ADMIN_PASSWORD). Замените домены на свои.