Перейти к содержимому
Oleaflyv0.4.12

Запуск сервера

Запуск сервера совместной работы

Что хранит Oleafly Server, что для него нужно, как установить его одной командой или запустить с Docker Compose, Coolify, Render, Railway или обычной службой Linux, а затем стать первым администратором сервера.

Oleafly Server является сервером, на котором строится совместная работа в реальном времени. Ваша лаборатория, отдел или учреждение запускает его на собственных машинах или в собственном облачном аккаунте. Люди добавляют его в Oleafly и входят с уже имеющимся у них аккаунтом, например GitHub или университетским. Когда кто-то делится проектом на сервере, добавленные им люди получают полную копию, которая остаётся синхронизированной, пока они редактируют. Если включён доступ из браузера, они могут также открыть проект в веб-браузере.

Это руководство для человека, который запускает сервер для лаборатории, курса или группы соавторов. Вы должны уверенно работать с терминалом. Некоторые способы развёртывания также требуют отредактировать файл настроек. Писать код не придётся.

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

Сервер хранит всё в одной папке данных, заданной переменной OLEAFLY_DATA_DIR:

  • Учётные записи: отображаемое имя каждого участника, адрес его аватара, подтверждённые адреса электронной почты, а также его идентификатор пользователя и логин у провайдера входа. Сервер никогда не видит и не хранит пароль.
  • Устройства: каждый компьютер, с которого выполнен вход, с его именем, операционной системой, открытым ключом и временем последнего появления в сети. Токены входа хранятся только в виде хешей.
  • Журнал безопасности: входы и отклонённые входы, добавленные устройства и выходы из них, изменения участников, ролей и настроек, проекты, которыми делились, архивировали и восстанавливали, изменения того, кто может открывать проект, и приглашения гостей. Каждая запись содержит время и IP-адрес.
  • Настройки сервера, которые администраторы меняют в Oleafly.
  • Журналы доступа к проектам, для проектов, владелец которых их включил: кто открывал проект, присоединялся к нему или скачивал копию, с именем устройства и временем. Читать такой журнал может только владелец проекта.
  • Приглашения гостей: приглашённый адрес электронной почты, проект, роль и отправитель.
  • Общие проекты: все файлы и полная история изменений, вместе с относящимися к ним комментариями, предложениями, чатом и названиями версий.
  • Скомпилированные PDF: для каждого общего проекта самый новый PDF и его файл SyncTeX, которые приложение владельца или редактора отправило после успешной компиляции, с указанием, кто и когда его скомпилировал.

Записи из журнала безопасности и журналов доступа, а также отвеченные и истёкшие приглашения гостей удаляются через OLEAFLY_SECURITY_LOG_DAYS дней, по умолчанию 365. Файлы, которые проект больше не использует, например старая копия заменённого рисунка, удаляются через 30 дней после того, как проект пользовался ими в последний раз. Каждый скомпилированный PDF заменяет предыдущий. Когда владелец перестаёт делиться проектом, сервер хранит его в режиме только для чтения OLEAFLY_ARCHIVE_DAYS дней, по умолчанию 30, а затем удаляет. В течение этого времени скачать его могут только владелец и администраторы проекта.

Проекты на сервере не шифруются. Любой, кто может прочитать папку данных, диск машины или ваши резервные копии, может прочитать каждый хранящийся там проект. Это касается и тех, кто управляет машиной, и компании, которая её размещает.

Внутри Oleafly правила строже. Ни одна роль на сервере, включая администратора, не может открыть проект, если владелец проекта не добавил этого человека. Если проект должен оставаться недоступным людям, которые управляют сервером, запустите для него отдельный сервер.

Компьютер каждого участника также хранит полную копию каждого проекта, которым с ним поделились. Попросите участников включить шифрование диска, например FileVault на macOS, BitLocker в Windows или LUKS в Linux.

  • Машина, которая всегда включена. Подойдёт любая машина с Linux или аккаунт в хостинге вроде Render или Railway. Для начала достаточно небольшой виртуальной машины. Следите за её памятью и диском по мере роста проектов. Сервер работает на x86-64 и ARM.
  • Доменное имя для сервера, например collab.example.org, с DNS-записью, указывающей на машину. Render и Railway выдадут адрес, если у вас нет своего. Если у машины нет публичного адреса, прочитайте раздел Без публичного адреса.
  • Способ входа для людей: как минимум один провайдер входа, например приложение GitHub OAuth или логин вашего учреждения. Без него сервер не запустится. Почтовый аккаунт, с которого сервер может отправлять письма, не обязателен. С ним администратор может также разрешить людям вход по ссылке из письма. Прочитайте раздел Вход и доступ.

Каждый релиз публикуется как образ контейнера ghcr.io/oleafly/oleafly-server. Установщик и его файлы Compose находятся на странице релизов Oleafly Server (откроется в новой вкладке). Сервер в виде отдельной программы для Linux — на странице релизов Oleafly (откроется в новой вкладке).

ВариантКогда использовать
Одна командаМашина с Linux, которую вы обслуживаете сами. Установщик настраивает Docker, Caddy и HTTPS и задаёт несколько вопросов. Если не уверены, начните отсюда.
Docker Compose вручнуюВы предпочитаете сами размещать и редактировать каждый файл.
CoolifyУ вас уже есть сервер Coolify.
Render или RailwayВы предпочитаете платить хостингу, а не обслуживать машину самостоятельно.
Linux без DockerУниверситетская виртуальная машина, где нельзя использовать Docker.

Сервер читает свои настройки из переменных окружения. Раздел Хранилище, резервные копии и ограничения перечисляет их все.

На машине с Linux, которую вы обслуживаете сами, установщик настраивает всё и спрашивает только то, что ему нужно знать.

Что делает установщикУстановщик выполняет шесть шагов по порядку. Проверяет, что машина работает на Linux с x86-64 или ARM, а порты 80 и 443 свободны. Устанавливает Docker, если его нет, предварительно спросив. Скачивает файлы выпуска и сверяет каждый с SHA256SUMS. Спрашивает домен, имя сервера, способ входа и, по желанию, почту. Записывает настройки в .env и запускает сервер с Caddy в /opt/oleafly-server. Когда сервер отвечает по HTTPS, выводит код настройки для первого администратора.Проверить машинуLinux, x86-64 или ARMПорты 80 и 443 свободныDockerУстанавливается, если нет,после вопросаСкачать и проверитьФайлы выпуска,сверенные по SHA256SUMSНесколько вопросовДомен, имя сервера,вход, почтаЗапускСервер и Caddyв /opt/oleafly-serverКод настройкиВыводится, когдасервер отвечаетЧто делает установщикУстановщик выполняет шесть шагов по порядку. Проверяет, что машина работает на Linux с x86-64 или ARM, а порты 80 и 443 свободны. Устанавливает Docker, если его нет, предварительно спросив. Скачивает файлы выпуска и сверяет каждый с SHA256SUMS. Спрашивает домен, имя сервера, способ входа и, по желанию, почту. Записывает настройки в .env и запускает сервер с Caddy в /opt/oleafly-server. Когда сервер отвечает по HTTPS, выводит код настройки для первого администратора.Проверить машинуLinux, x86-64 или ARMПорты 80 и 443 свободныDockerУстанавливается, если нет,после вопросаСкачать и проверитьФайлы выпуска,сверенные по SHA256SUMSНесколько вопросовДомен, имя сервера,вход, почтаЗапускСервер и Caddyв /opt/oleafly-serverКод настройкиВыводится, когдасервер отвечает
Одна команда: проверка, Docker, загрузка и сверка, несколько вопросов, запуск и затем код настройки.

Перед запуском проверьте, что:

  • На машине работает Linux на x86-64 или ARM, например Ubuntu 24.04 или Debian 13, и вы можете пользоваться на ней sudo.
  • Ничто другое на машине не занимает порты 80 и 443. Откройте TCP-порты 80 и 443 и UDP-порт 443 в любом брандмауэре перед ней.
  • DNS-запись вашего домена указывает на машину. Если пока нет, установка всё равно завершится, а Caddy будет продолжать добиваться сертификата, пока запись не появится.
  • У вас есть данные как минимум одного провайдера входа, например client ID и secret приложения GitHub OAuth. Для GitHub адрес обратного вызова — это https://, ваш домен и затем /auth/callback/github.

Затем выполните:

Окно терминала
curl -fsSL https://oleafly.com/server/install.sh | sudo sh

Установщик:

  1. Проверяет машину и то, что порты 80 и 443 свободны.
  2. Проверяет Docker. Если его нет, установщик спрашивает разрешения, прежде чем устанавливать его скриптом самого Docker.
  3. Скачивает файлы новейшего релиза со страницы релизов Oleafly Server (откроется в новой вкладке) и сверяет каждый с файлом SHA256SUMS этого релиза. Если файл не совпадает, установка останавливается, ничего не меняя.
  4. Спрашивает ваш домен, имя сервера и то, как люди будут входить. Он также предлагает настроить почту и хранить файлы в бакете S3. И то и другое необязательно.
  5. Показывает сводку и спрашивает разрешения, прежде чем что-либо изменить. Затем он записывает свои файлы в /opt/oleafly-server, а ваши настройки — в .env, который может прочитать только root.
  6. Запускает сервер с Caddy впереди, ждёт, пока ваш домен не начнёт отвечать по HTTPS, и выводит адрес и код настройки.

Затем станьте первым администратором.

Установщик можно запустить снова в любой момент. Обнаружив сервер в /opt/oleafly-server, он оставляет .env как есть, восстанавливает остальные файлы и перезапускает сервер. Это исправляет большинство сломанных установок.

Ваши данные находятся в томе Docker oleafly-server_oleafly-data. Чтобы установить сервер не в /opt/oleafly-server, задайте OLEAFLY_DIR, например curl -fsSL https://oleafly.com/server/install.sh | sudo OLEAFLY_DIR=/srv/oleafly sh, и используйте эту папку в командах ниже.

Если ваше учреждение не разрешает передавать скрипт прямо в оболочку, скачайте install.sh и SHA256SUMS из последнего релиза (откроется в новой вкладке) в одну папку. Проверьте и прочитайте скрипт, затем запустите его:

Окно терминала
sha256sum --check --ignore-missing SHA256SUMS
sudo sh install.sh

Для скрипта или инструмента провижинирования добавьте --yes и передайте ответы переменными окружения. OLEAFLY_INSTALL_DOCKER=yes разрешает установщику добавить Docker, если его нет.

Окно терминала
curl -fsSL https://oleafly.com/server/install.sh | sudo \
OLEAFLY_DOMAIN=collab.example.org \
OLEAFLY_SERVER_NAME='Smith Lab' \
OLEAFLY_GITHUB_CLIENT_ID=Ov23liExampleClientId \
OLEAFLY_GITHUB_CLIENT_SECRET=example-client-secret \
OLEAFLY_INSTALL_DOCKER=yes \
sh -s -- --yes

Установщик использует любую настройку, которую находит в окружении, не спрашивая, с --yes или без него. Команда sudo sh /opt/oleafly-server/install.sh --help перечисляет их все, включая OpenID Connect, почту и S3. Значения, введённые в командной строке, могут попасть в историю оболочки, поэтому инструмент провижинирования должен передавать секреты из собственного хранилища секретов.

  • Статус: sudo sh /opt/oleafly-server/install.sh status показывает, работает ли сервер и отвечает ли ваш домен по HTTPS с действительным сертификатом.

  • Обновление: сначала сделайте резервную копию, как описано в разделе Обновление. Затем выполните команду ниже. Она скачивает файлы и образ новейшего релиза, сохраняет .env, перезапускает сервер и ждёт, пока он не начнёт отвечать. Подключённые люди переподключаются сами. Установщик никогда не переводит сервер на более старый релиз.

    Окно терминала
    curl -fsSL https://oleafly.com/server/install.sh | sudo sh -s -- update
  • Удаление: sudo sh /opt/oleafly-server/install.sh uninstall останавливает и удаляет контейнеры. Ваши данные и .env останутся, если только вы не введёте delete, когда установщик спросит. Их удаление стирает каждый общий проект на сервере, каждую учётную запись и журнал безопасности. Собственные копии проектов остаются на компьютерах людей.

Если установщик останавливается на проблеме, которую вы не можете решить, сообщите о ней (откроется в новой вкладке), приложив то, что он вывел.

Эта конфигурация запускает два контейнера. oleafly-server — это сам сервер, и добраться до него могут только другие контейнеры. caddy получает сертификат от Let’s Encrypt, обслуживает HTTPS на портах 80 и 443 и передаёт запросы серверу, включая подключения в реальном времени.

Развёртывание через Docker ComposeOleafly на каждом компьютере подключается по HTTPS к Caddy на вашей машине. Caddy хранит сертификат и передаёт запросы по обычному HTTP контейнеру oleafly-server. Сервер держит базу данных и файлы в томе данных Docker, а файлы может хранить и в бакете S3.Ваша машина с Docker ComposeOleaflyНа каждомкомпьютереCaddyHTTPSсертификатoleafly-serverНастройки в .envТом данныхБаза данных,файлыБакет S3НеобязательноРазвёртывание через Docker ComposeOleafly на каждом компьютере подключается по HTTPS к Caddy на вашей машине. Caddy хранит сертификат и передаёт запросы по обычному HTTP контейнеру oleafly-server. Сервер держит базу данных и файлы в томе данных Docker, а файлы может хранить и в бакете S3.Ваша машина с Docker ComposeOleaflyНа каждом компьютереCaddyСертификат HTTPSoleafly-serverНастройки в .envТом данныхБаза данных, файлыБакет S3Необязательно, файлыHTTPSHTTP
Docker Compose: Caddy обрабатывает HTTPS перед сервером, а том данных хранит базу данных и файлы.
  1. Установите Docker Engine и плагин Compose, следуя инструкциям Docker (откроется в новой вкладке).

  2. Наведите DNS-запись вашего домена на машину. Откройте TCP-порты 80 и 443 и UDP-порт 443 в любом брандмауэре перед ней. Caddy нужен порт 80 для получения сертификата.

  3. Создайте папку для сервера, скачайте в неё файлы новейшего релиза, проверьте их и создайте файл настроек:

    Окно терминала
    sudo mkdir -p /opt/oleafly-server && cd /opt/oleafly-server
    base=https://github.com/Oleafly/oleafly-server/releases/latest/download
    for f in docker-compose.yml Caddyfile env.example litestream.yml SHA256SUMS; do sudo curl -fsSLO "$base/$f"; done
    sha256sum --check --ignore-missing SHA256SUMS
    sudo install -m 600 env.example .env
  4. Отредактируйте .env командой sudoedit .env. Задайте в OLEAFLY_DOMAIN ваш домен без https://, задайте OLEAFLY_SERVER_NAME и заполните как минимум один провайдер входа. Строки провайдеров, которыми вы не пользуетесь, оставьте пустыми. Заключайте значение в одинарные кавычки, если оно содержит $ или #.

  5. Запустите сервер. При первом запуске скачивается образ сервера ghcr.io/oleafly/oleafly-server версии релиза.

    Окно терминала
    sudo docker compose up -d
  6. Проверьте, что сервер отвечает. Эта команда выводит 200:

    Окно терминала
    curl -sS -o /dev/null -w '%{http_code}\n' https://collab.example.org/healthz
  7. Станьте первым администратором. Код настройки находится в журнале:

    Окно терминала
    sudo docker compose logs oleafly-server | grep 'Setup code'

Ваши данные находятся в томе Docker oleafly-server_oleafly-data. Caddy хранит свои сертификаты в oleafly-server_caddy-data.

Docker сам открывает порты 80 и 443, даже когда включён брандмауэр хоста вроде ufw. Именно это и нужно Caddy. Не добавляйте запись ports: к службе oleafly-server. Чтобы обратиться к серверу с самой машины, опубликуйте его как 127.0.0.1:8080:8080, чтобы он не был виден из сети.

Если вы измените Caddyfile, выполните sudo docker compose up -d --force-recreate caddy. Чтобы обновиться позже, скачайте файлы нового релиза тем же способом и снова выполните sudo docker compose up -d.

Секреты могут содержать семь настроек: OLEAFLY_SETUP_CODE, OLEAFLY_GITHUB_CLIENT_SECRET, OLEAFLY_OIDC_<NAME>_CLIENT_SECRET, OLEAFLY_SMTP_URL, OLEAFLY_BLOB_STORE, OLEAFLY_S3_ACCESS_KEY_ID и OLEAFLY_S3_SECRET_ACCESS_KEY. У каждой есть вариант с _FILE, в котором задаётся файл со значением. Задавайте что-то одно из двух.

Например, чтобы передать client secret GitHub как Docker secret, сохраните его в secrets/github_client_secret рядом с docker-compose.yml, разрешите пользователю сервера (ID 10001) читать его и удалите строку OLEAFLY_GITHUB_CLIENT_SECRET из .env:

Окно терминала
sudo chown 10001:10001 secrets/github_client_secret
sudo chmod 400 secrets/github_client_secret

Затем создайте docker-compose.override.yml рядом с docker-compose.yml. Compose читает его автоматически, а установщик не трогает его при обновлении остальных файлов.

services:
oleafly-server:
environment:
OLEAFLY_GITHUB_CLIENT_SECRET_FILE: /run/secrets/github_client_secret
secrets:
- github_client_secret
secrets:
github_client_secret:
file: ./secrets/github_client_secret

Снова выполните sudo docker compose up -d.

Coolify ставит собственный прокси перед сервером и получает сертификат, поэтому в этой конфигурации нет Caddy. Coolify может собрать сервер из репозитория Oleafly или запустить готовый образ, что пропускает сборку.

Развёртывание через CoolifyOleafly на каждом компьютере подключается, при желании через Cloudflare, к прокси Coolify, который обрабатывает HTTPS и передаёт запросы oleafly-server. Сервер хранит данные в томе Docker. Если Cloudflare стоит перед прокси Coolify, каждый запрос проходит через два прокси, поэтому задайте OLEAFLY_PROXY_HOPS равным 2.OleaflyНа каждомкомпьютереCloudflareНеобязательноПрокси CoolifyHTTPSoleafly-serverНа вашем сервереCoolifyТом данныхЕсли впереди оба, задайтеOLEAFLY_PROXY_HOPS=2Развёртывание через CoolifyOleafly на каждом компьютере подключается, при желании через Cloudflare, к прокси Coolify, который обрабатывает HTTPS и передаёт запросы oleafly-server. Сервер хранит данные в томе Docker. Если Cloudflare стоит перед прокси Coolify, каждый запрос проходит через два прокси, поэтому задайте OLEAFLY_PROXY_HOPS равным 2.OleaflyНа каждом компьютереCloudflareНеобязательноПрокси CoolifyHTTPSoleafly-serverНа вашем сервере CoolifyТом данныхЕсли впереди оба, задайтеOLEAFLY_PROXY_HOPS=2
Coolify: его прокси обрабатывает HTTPS. Если перед ним ещё и Cloudflare, задайте OLEAFLY_PROXY_HOPS=2.

Прежде чем начать, наведите DNS-запись вашего домена, например collab.example.org, на сервер Coolify. Затем создайте приложение GitHub OAuth, как описано в разделе GitHub, с адресом обратного вызова https://collab.example.org/auth/callback/github. Держите его client ID и secret под рукой.

  1. В своём проекте Coolify выберите + New, затем Public Repository и введите https://github.com/Oleafly/Oleafly. Оставьте ветку main.
  2. Установите Build Pack в значение Docker Compose, Base Directory в значение /, а Docker Compose Location в значение /deploy/server/docker-compose.coolify.yml, затем выберите Continue.
  3. В разделе Advanced › Build установите Build arguments в значение Managed manually in Dockerfile. Образу сервера аргументы сборки не нужны. Если оставить автоматический режим, Coolify записывает в историю сборки образа каждую переменную, включая секреты.
  4. В разделе General задайте для oleafly-server домен https://collab.example.org:8080 и сохраните. :8080 сообщает прокси Coolify, на каком порту слушает сервер. Люди всё равно подключаются по обычному HTTPS-порту, а Coolify сам задаёт OLEAFLY_PUBLIC_URL равным https://collab.example.org.
  5. В разделе Environment Variables заполните OLEAFLY_SERVER_NAME, которую Coolify помечает как обязательную, затем OLEAFLY_GITHUB_CLIENT_ID и OLEAFLY_GITHUB_CLIENT_SECRET. Переменные, которыми не пользуетесь, оставьте пустыми.
  6. Выберите Deploy. Первая сборка компилирует сервер и занимает несколько минут. Когда она завершится, Coolify покажет ресурс запущенным и работоспособным.
  7. Откройте https://collab.example.org/healthz в браузере. Там отображается {"status":"ok"}.
  8. Откройте Logs, выберите контейнер oleafly-server и скопируйте код из самой новой строки, которая начинается с Setup code:.
  9. Станьте первым администратором с этим кодом.

Если сервер не запускается, его журнал называет настройку, которую не может использовать. Если в журнале сказано, что OLEAFLY_PUBLIC_URL не задан, пропущен шаг 4. Домен, начинающийся с http://, отклоняется, потому что серверу нужен HTTPS.

Если перед Coolify стоит Cloudflare, потому что ваша DNS-запись идёт через прокси Cloudflare или туннель ведёт к прокси Coolify, задайте OLEAFLY_PROXY_HOPS равным 2. Без этого журнал безопасности показывает для всех адрес прокси, и все делят один лимит входа.

В файле Coolify есть место для GitHub и одного провайдера OpenID Connect с именем UNIVERSITY. Задайте в OLEAFLY_OIDC_UNIVERSITY_LABEL текст, который должны видеть люди, например GitLab. Его адрес обратного вызова заканчивается на /auth/callback/university. Чтобы добавить больше провайдеров, разверните сервер из ответвления с собственной копией этого файла.

Данные находятся в томе Docker, имя которого заканчивается на oleafly-data. Найдите его командой docker volume ls --filter name=oleafly-data. В образе нет оболочки, поэтому Terminal в Coolify не может открыть её в контейнере сервера. Журналы и проверка работоспособности работают как обычно.

Запуск готового образа пропускает сборку, что подходит для небольшого сервера Coolify. Выполните описанные выше шаги с двумя изменениями. На шаге 2 задайте Docker Compose Location равным /deploy/server/docker-compose.coolify-image.yml. Пропустите шаг 3, так как ничего не собирается. Файл следует за одной серией релизов, поэтому каждое нажатие Redeploy подтягивает её новейший релиз.

Deploy to Render (откроется в новой вкладке) читает Blueprint из репозитория Oleafly. Он создаёт одну веб-службу из готового образа с диском на 1 ГБ для папки данных. Render подключает диски только к платным типам инстансов, поэтому служба запускается на самом маленьком платном, в орегонском регионе Render. Для другого региона разверните из ответвления, задав region в render.yaml.

  1. Откройте ссылку и войдите в Render.
  2. Render запрашивает OLEAFLY_SERVER_NAME, а также client ID и secret GitHub. Заполните имя, а поля GitHub пока оставьте пустыми: их адрес обратного вызова зависит от адреса службы, которого у вас ещё нет.
  3. Выберите Deploy Blueprint. Когда служба начнёт работать, её страница покажет её адрес, например https://oleafly-server.onrender.com. Blueprint задаёт OLEAFLY_PUBLIC_URL равным этому адресу.
  4. Создайте приложение GitHub OAuth, как описано в разделе GitHub, указав в качестве адреса обратного вызова этот адрес, а после него /auth/callback/github. Добавьте client ID и secret в разделе Environment службы. Render перезапустит сервер с ними.
  5. Найдите самую новую строку Setup code: в разделе Logs службы и станьте первым администратором.

Если вы назначаете службе собственный домен, задайте в разделе Environment переменную OLEAFLY_PUBLIC_URL равной ему и измените адрес обратного вызова у GitHub так, чтобы он совпадал.

Из-за диска Render останавливает работающий сервер перед запуском нового, поэтому каждое развёртывание на несколько секунд отключает сервер. Oleafly переподключается сам.

Railway запускает готовый образ с томом для папки данных.

  1. В проекте Railway выберите + New, затем Docker Image и введите ghcr.io/oleafly/oleafly-server:latest. Чтобы самому выбирать момент обновления, используйте вместо этого тег конкретного релиза со страницы релизов (откроется в новой вкладке). Railway может сразу запустить первое развёртывание. Оно остановится с ошибкой OLEAFLY_PUBLIC_URL is not set, и на этом этапе это ожидаемо.

  2. Откройте службу. В разделе Settings › Networking выберите Generate Domain и укажите порт 8080. Railway покажет адрес, например oleafly-server-production.up.railway.app.

  3. В разделе Settings › Deploy задайте Healthcheck Path равным /readyz.

  4. Щёлкните правой кнопкой мыши по холсту проекта, добавьте том, подключите его к службе сервера и задайте путь монтирования /data.

  5. В разделе Variables откройте Raw Editor и вставьте эти строки, подставив собственное имя сервера. Для значений GitHub следуйте разделу GitHub. Адрес обратного вызова — ваш адрес из шага 2, с https:// впереди и /auth/callback/github в конце.

    OLEAFLY_PUBLIC_URL=https://${{RAILWAY_PUBLIC_DOMAIN}}
    OLEAFLY_BIND=0.0.0.0:8080
    OLEAFLY_DATA_DIR=/data
    OLEAFLY_BEHIND_PROXY=true
    OLEAFLY_SERVER_NAME=Smith Lab
    OLEAFLY_GITHUB_CLIENT_ID=Ov23liExampleClientId
    OLEAFLY_GITHUB_CLIENT_SECRET=example-client-secret
    PORT=8080
    RAILWAY_RUN_UID=0

    Railway монтирует тома от имени root. RAILWAY_RUN_UID=0 запускает сервер от имени root, чтобы он мог писать в том.

  6. Разверните изменения. Найдите самую новую строку Setup code: в разделе Deploy Logs службы и станьте первым администратором.

На машине без Docker сервер работает как отдельная программа под systemd, с Caddy впереди для HTTPS.

Развёртывание на Linux без DockerOleafly на каждом компьютере подключается по HTTPS к Caddy на вашей машине с Linux. Caddy передаёт запросы oleafly-server, который работает как служба systemd на 127.0.0.1, порт 8080, и хранит данные в /var/lib/oleafly-server.Ваша машина с LinuxOleaflyНа каждомкомпьютереCaddyHTTPSсертификатoleafly-serverСлужба systemdПапка данных/var/lib/oleafly-serverРазвёртывание на Linux без DockerOleafly на каждом компьютере подключается по HTTPS к Caddy на вашей машине с Linux. Caddy передаёт запросы oleafly-server, который работает как служба systemd на 127.0.0.1, порт 8080, и хранит данные в /var/lib/oleafly-server.Ваша машина с LinuxOleaflyНа каждом компьютереCaddyСертификат HTTPSoleafly-serverСлужба systemdПапка данных/var/lib/oleafly-serverHTTPSHTTP
Linux без Docker: systemd запускает сервер, а Caddy перед ним обрабатывает HTTPS.

Каждый релиз сервера на странице релизов (откроется в новой вкладке) содержит готовую программу для x86-64 и для ARM, а также файл SHA256SUMS для проверки. Для программы больше ничего устанавливать не нужно.

Скачайте архив для вашей машины — его имя заканчивается на x86_64-unknown-linux-musl.tar.gz или aarch64-unknown-linux-musl.tar.gz — и файл SHA256SUMS в одну папку. Затем проверьте и установите программу. На машине с ARM используйте aarch64 вместо x86_64:

Окно терминала
sha256sum --check --ignore-missing SHA256SUMS
tar -xzf oleafly-server-*-x86_64-unknown-linux-musl.tar.gz
sudo install -m 0755 oleafly-server-*-x86_64-unknown-linux-musl/oleafly-server /usr/local/bin/oleafly-server
oleafly-server --version

Если установлен GitHub CLI, команда gh attestation verify oleafly-server-*-x86_64-unknown-linux-musl.tar.gz --repo Oleafly/Oleafly дополнительно подтверждает, что GitHub собрал архив из репозитория Oleafly. В архив входит юнит systemd — oleafly-server.service.

Чтобы вместо этого собрать программу самостоятельно, выполните следующее в клоне репозитория Oleafly на любом компьютере с Docker. Для ARM-сервера используйте --platform linux/arm64.

Окно терминала
docker buildx build --platform linux/amd64 --target binary --output type=local,dest=dist -f crates/oleafly-server/Dockerfile .

Команда создаст dist/oleafly-server. Скопируйте его в /usr/local/bin/oleafly-server на сервере и сделайте исполняемым.

  1. Создайте файл настроек. Читать его может только root:

    Окно терминала
    sudo install -d -m 0755 /etc/oleafly-server
    sudo install -m 0600 /dev/null /etc/oleafly-server/oleafly-server.env
    sudoedit /etc/oleafly-server/oleafly-server.env

    Указывайте по одной настройке в строке. OLEAFLY_BIND=127.0.0.1:8080 не выпускает сервер в сеть, так что до него может добраться только Caddy. Не задавайте OLEAFLY_DATA_DIR: его задаёт сам юнит.

    OLEAFLY_PUBLIC_URL=https://collab.example.org
    OLEAFLY_BIND=127.0.0.1:8080
    OLEAFLY_BEHIND_PROXY=true
    OLEAFLY_SERVER_NAME=Smith Lab
    OLEAFLY_GITHUB_CLIENT_ID=Ov23liExampleClientId
    OLEAFLY_GITHUB_CLIENT_SECRET=example-client-secret
  2. Установите и запустите юнит из распакованного архива или из папки deploy/server в клоне репозитория. Затем найдите код настройки:

    Окно терминала
    sudo install -m 0644 oleafly-server.service /etc/systemd/system/oleafly-server.service
    sudo systemctl daemon-reload
    sudo systemctl enable --now oleafly-server
    sudo journalctl -u oleafly-server | grep 'Setup code'

Юнит запускает сервер от имени выделенного пользователя, которого systemd создаёт для него, с доступом только для чтения к остальной системе. Единственное место, куда он может писать, — /var/lib/oleafly-server, где он хранит свои данные. На диске эта папка называется /var/lib/private/oleafly-server.

Чтобы клиентский секрет не попадал в файл настроек, используйте учётные данные systemd. Сохраните секрет в /etc/oleafly-server/github-client-secret с правами 600, удалите строку OLEAFLY_GITHUB_CLIENT_SECRET из файла настроек, выполните sudo systemctl edit oleafly-server и добавьте:

[Service]
LoadCredential=github-client-secret:/etc/oleafly-server/github-client-secret
Environment=OLEAFLY_GITHUB_CLIENT_SECRET_FILE=%d/github-client-secret

Затем выполните sudo systemctl restart oleafly-server.

Установите Caddy, следуя инструкциям для вашего дистрибутива (откроется в новой вкладке). Замените /etc/caddy/Caddyfile этими строками и выполните sudo systemctl reload caddy. Caddy получит сертификат и будет передавать подключения в реальном времени.

collab.example.org {
reverse_proxy 127.0.0.1:8080
}

Для nginx, Apache или веб-сервера, которым уже пользуется ваш университет, прочитайте раздел За обратным прокси.

Если у машины нет публичного адреса, например это компьютер в вашей лаборатории за университетским брандмауэром, сделать её доступной может Cloudflare Tunnel. Вам нужен аккаунт Cloudflare, к которому подключён ваш домен. Cloudflare обрабатывает HTTPS для этого имени хоста, поэтому запросы расшифровываются в сети Cloudflare ещё до того, как попадают на вашу машину. Считайте Cloudflare одной из сторон, способных читать трафик к вашему серверу.

Развёртывание через Cloudflare TunnelOleafly на каждом компьютере подключается по HTTPS к Cloudflare. Контейнер cloudflared на вашей машине открывает туннель к Cloudflare, поэтому машине не нужен публичный адрес. Запросы приходят по туннелю в cloudflared, а он передаёт их oleafly-server.Ваша машина без публичного адресаOleaflyНа каждомкомпьютереCloudflareHTTPScloudflaredОткрывает туннельoleafly-serverТом данныхРазвёртывание через Cloudflare TunnelOleafly на каждом компьютере подключается по HTTPS к Cloudflare. Контейнер cloudflared на вашей машине открывает туннель к Cloudflare, поэтому машине не нужен публичный адрес. Запросы приходят по туннелю в cloudflared, а он передаёт их oleafly-server.Ваша машина без публичного адресаOleaflyНа каждом компьютереCloudflareHTTPScloudflaredОткрывает туннельoleafly-serverТом данныхТуннель
Cloudflare Tunnel: машина сама открывает туннель, поэтому публичный адрес ей не нужен.
  1. Выполните шаги раздела Docker Compose вручную до редактирования .env. Задайте OLEAFLY_DOMAIN равным имени хоста, которое вы будете использовать, например collab.example.org. Установщик с одной командой здесь не подходит, потому что он запускает Caddy.

  2. Запустите только сервер. Caddy здесь не нужен:

    Окно терминала
    sudo docker compose up -d oleafly-server
  3. В панели Cloudflare перейдите в Networking › Tunnels, выберите Create Tunnel, дайте туннелю имя и снова выберите Create Tunnel. Скопируйте токен из показанной команды установки.

  4. Запустите туннель рядом с сервером. Команда read ждёт, пока вы вставите токен, и не показывает его:

    Окно терминала
    read -rs TUNNEL_TOKEN && export TUNNEL_TOKEN
    sudo --preserve-env=TUNNEL_TOKEN docker run -d --name oleafly-tunnel --restart unless-stopped --network oleafly-server_default -e TUNNEL_TOKEN cloudflare/cloudflared:2026.10.0 tunnel --no-autoupdate run
  5. Вернувшись в панель, откройте туннель. В разделе Routes выберите Add route, затем Published application. В разделе Hostname введите поддомен и выберите ваш домен. Задайте Service URL равным http://oleafly-server:8080 и выберите Add route.

  6. Проверьте, что сервер отвечает по https://collab.example.org/healthz, затем станьте первым администратором.

На машине без Docker установите cloudflared из репозитория пакетов Cloudflare (откроется в новой вкладке), выполните sudo cloudflared service install, а затем укажите токен, и задайте Service URL равным http://127.0.0.1:8080.

Cloudflare пропускает подключения в реальном времени и ставит адрес посетителя последним в X-Forwarded-For, поэтому оставьте OLEAFLY_BEHIND_PROXY=true. Если туннель ведёт не прямо к серверу, а к другому прокси, например прокси Coolify, также задайте OLEAFLY_PROXY_HOPS=2. На планах Free и Pro Cloudflare отклоняет запросы больше 100 МБ, поэтому задайте OLEAFLY_MAX_PROJECT_MB равным 100 или меньше, иначе большие проекты не смогут загрузиться.

Когда позже вы будете обновлять сервер, скачайте файлы нового релиза тем же способом и укажите имя службы, чтобы Caddy не запускался: sudo docker compose up -d oleafly-server.

У нового сервера нет администратора. Пока никто не завершил настройку, сервер при каждом запуске создаёт новый одноразовый код настройки и записывает его в свой журнал.

  1. Найдите в журнале самую новую строку, которая начинается с Setup code::
    • Установка одной командой: установщик выводит код по завершении. Чтобы увидеть его снова, выполните cd /opt/oleafly-server && sudo docker compose logs oleafly-server | grep 'Setup code'
    • Docker Compose вручную: sudo docker compose logs oleafly-server | grep 'Setup code' в папке сервера
    • Coolify: журналы службы oleafly-server
    • systemd: sudo journalctl -u oleafly-server | grep 'Setup code'
  2. В Oleafly откройте Настройки → Совместная работа, выберите Добавить сервер и введите адрес вашего сервера. Oleafly увидит, что серверу нужна настройка, и попросит код настройки.
  3. Введите код и войдите через любой настроенный вами провайдер. Вы станете администратором сервера, и код перестанет работать.

Любой, у кого окажется код до того, как вы его используете, может назначить себя администратором, поэтому вводите его только в Oleafly.

Можно также выбрать код самостоятельно с помощью OLEAFLY_SETUP_CODE: минимум 12 букв или цифр, при желании с дефисами или пробелами. Тогда сервер никогда не выводит его. В журнале будет только Setup code: set by OLEAFLY_SETUP_CODE, а вы вводите заданное вами значение. Уберите его из настроек, когда настройка завершена.

Дальше впустите людей. Как это сделать, объясняет раздел Вход и доступ.

  • При установке одной командой sudo sh /opt/oleafly-server/install.sh status проверяет контейнеры и HTTPS за один раз.
  • https://collab.example.org/healthz отвечает 200, пока работает процесс сервера.
  • /readyz отвечает 200, только пока сервер может писать в свою базу данных и папку данных. Если не может, например при заполненном диске, он отвечает 503 и называет причину: database или storage.
  • Образ Docker сам проверяет /readyz, поэтому docker ps и Coolify показывают неработоспособный сервер, а не работающий, который не может ничего сохранить.
  • В Oleafly кнопка Проверить подключение в разделе Настройки → Совместная работа проверяет адрес, HTTPS, версию, подключения в реальном времени, варианты входа и часы сервера. Проверка подключения в консоли администратора выполняет те же проверки.
Просмотр изображения

Не удалось загрузить ответы ИИ

Попробуйте снова или воспользуйтесь поиском по документации.