コンテンツにスキップ
Oleaflyv0.4.12

サーバーを運用する

共同編集サーバーを運用する

Oleafly Server が保存するもの、必要なもの、1 つのコマンドでのインストール方法、Docker Compose、Coolify、Render、Railway、通常の Linux サービスでの実行方法、そして最初の管理者になる手順を説明します。

Oleafly Server は、ライブ共同編集を支える共同編集サーバーです。研究室、学部、研究機関が、自分たちのマシンや自分たちのクラウドアカウントで運用します。ユーザーは Oleafly でサーバーを追加し、GitHub や大学のログインなど、すでに持っているアカウントでサインインします。誰かがサーバー上でプロジェクトを共有すると、追加されたユーザーは完全なコピーを受け取り、編集している間そのコピーは同期され続けます。ブラウザからのアクセスがオンなら、Web ブラウザでプロジェクトを開くこともできます。

このガイドは、研究室、授業、共同執筆者のグループのためにサーバーを運用する人向けです。ターミナルの操作に慣れている必要があります。設定ファイルの編集が必要なセットアップもありますが、コードを書く必要はありません。

セキュリティレビューのためには、サーバーのセキュリティをお読みください。セルフホスティング、サインイン、デバイスキー、署名付きの変更、セキュリティログとアクセスログ、そしてソフトウェア部品表付きのコンテナイメージを扱っています。

サーバーは、すべてを OLEAFLY_DATA_DIR で指定する 1 つのデータフォルダに保存します。

  • アカウント:各メンバーの表示名、アバターのアドレス、確認済みのメールアドレス、およびサインインプロバイダ上でのユーザー ID とログイン名。サーバーがパスワードを見たり保存したりすることはありません。
  • デバイス:サインインした各コンピュータの、名前、オペレーティングシステム、公開鍵、最後に確認された時刻。サインイン用のトークンは、ハッシュとしてのみ保存されます。
  • セキュリティログ:サインインと拒否されたサインイン、追加およびサインアウトされたデバイス、メンバー、役割、設定の変更、共有、アーカイブ、復元されたプロジェクト、プロジェクトを開けるユーザーの変更、ゲストの招待。各項目には時刻と IP アドレスが記録されます。
  • 管理者が Oleafly で変更するサーバー設定。
  • プロジェクトのアクセスログ:所有者がオンにしたプロジェクトについて、誰がプロジェクトを開いたか、参加したか、コピーをダウンロードしたかを、デバイス名と時刻とともに記録します。読めるのは、そのプロジェクトの所有者だけです。
  • ゲストの招待:招待されたメールアドレス、プロジェクト、役割、送信した人。
  • 共有プロジェクト:すべてのファイルと、変更の完全な履歴。プロジェクトに属するコメント、提案、チャット、バージョン名も含みます。
  • コンパイル済みの PDF:共有プロジェクトごとに、コンパイルの成功後に所有者または編集者のアプリが送った最新の PDF とその SyncTeX ファイル。誰がいつコンパイルしたかも記録します。

セキュリティログとアクセスログの項目、および応答済みまたは期限切れのゲストの招待は、OLEAFLY_SECURITY_LOG_DAYS 日後(既定では 365 日)に削除されます。置き換えられた図の古いコピーなど、プロジェクトがもう使っていないファイルは、プロジェクトが最後に使ってから 30 日後に削除されます。コンパイル済みの PDF は、新しいものが届くたびに前のものと置き換わります。所有者がプロジェクトの共有を停止すると、サーバーはそのプロジェクトを OLEAFLY_ARCHIVE_DAYS 日間(既定では 30 日)読み取り専用で保持し、その後削除します。その間にダウンロードできるのは、所有者と、そのプロジェクトにいる管理者だけです。

プロジェクトを読めるのは誰か

「プロジェクトを読めるのは誰か」セクション

プロジェクトは、サーバー上では暗号化されていません。データフォルダ、マシンのディスク、バックアップを読める人は誰でも、そこに保存されているすべてのプロジェクトを読めます。マシンを運用する人や、それをホストする会社も含まれます。

Oleafly の内側では、ルールはもっと厳しくなっています。管理者を含め、どのサーバーの役割でも、プロジェクトの所有者が追加しない限り、そのプロジェクトを開くことはできません。サーバーを運用する人たちに見せてはいけないプロジェクトがある場合は、そのためだけに別のサーバーを運用してください。

各メンバーのコンピュータにも、共有されたプロジェクトの完全なコピーが保存されます。メンバーには、macOS の FileVault、Windows の BitLocker、Linux の LUKS などのディスク暗号化をオンにするよう依頼してください。

  • 常時稼働するマシン。 Linux マシンならどれでも使えます。Render や Railway などのホスティングサービスのアカウントでもかまいません。最初は小さな仮想マシンで足ります。プロジェクトが増えたら、メモリとディスクを見守ってください。サーバーは x86-64 と ARM で動作します。
  • サーバー用のドメイン名(collab.example.org など)と、そのマシンを指す DNS レコード。ドメインがない場合でも、Render と Railway ではアドレスが提供されます。マシンに公開アドレスがない場合は、公開アドレスがない場合をお読みください。
  • ユーザーがサインインする方法:GitHub OAuth アプリや所属機関のログインなど、サインインプロバイダが少なくとも 1 つ必要です。1 つもないと、サーバーは起動しません。サーバーから送信できるメールアカウントは任意です。あれば、管理者はメールで送るリンクによるサインインも許可できます。サインインとアクセスをお読みください。

各リリースは、コンテナイメージ ghcr.io/oleafly/oleafly-server として公開されます。インストーラーとその Compose ファイルは、Oleafly Server のリリースページ (新しいタブで開きます)にあります。単一の Linux プログラムとしてのサーバーは、Oleafly のリリースページ (新しいタブで開きます)にあります。

方法向いている場合
1 つのコマンド自分で管理している Linux マシン。インストーラーが Docker、Caddy、HTTPS を設定し、いくつか質問をします。迷ったら、ここから始めてください。
Docker Compose を手動で使う各ファイルを自分で配置して編集したい場合。
Coolifyすでに Coolify サーバーを運用している場合。
Renderまたは Railwayマシンを管理するより、ホスティングサービスに料金を払いたい場合。
Docker を使わない LinuxDocker を使えない大学の仮想マシン。

サーバーは、設定を環境変数から読み取ります。すべての設定はストレージ、バックアップ、上限に一覧があります。

1 つのコマンドでインストールする

「1 つのコマンドでインストールする」セクション

自分で管理している Linux マシンでは、インストーラーがすべてをセットアップし、必要なことだけを尋ねます。

インストーラーの動作インストーラーは 6 つのステップを順に実行します。マシンが Linux(x86-64 または ARM)で、80 番と 443 番のポートが空いていることを確認します。Docker がなければ、確認したうえでインストールします。リリースのファイルをダウンロードし、それぞれを SHA256SUMS で検証します。ドメイン、サーバー名、サインイン方法、そして任意でメールについて尋ねます。設定を .env に書き込み、/opt/oleafly-server で Caddy とともにサーバーを起動します。サーバーが HTTPS で応答すると、最初の管理者用のセットアップコードを表示します。マシンを確認Linux、x86-64 または ARMポート 80 と 443 が空きDockerなければインストール、確認のうえダウンロードと検証リリースのファイルを、SHA256SUMS で検証いくつかの質問ドメイン、サーバー名、サインイン、メール起動サーバーと Caddy/opt/oleafly-server 内セットアップコードサーバーが応答すると表示されますインストーラーの動作インストーラーは 6 つのステップを順に実行します。マシンが Linux(x86-64 または ARM)で、80 番と 443 番のポートが空いていることを確認します。Docker がなければ、確認したうえでインストールします。リリースのファイルをダウンロードし、それぞれを SHA256SUMS で検証します。ドメイン、サーバー名、サインイン方法、そして任意でメールについて尋ねます。設定を .env に書き込み、/opt/oleafly-server で Caddy とともにサーバーを起動します。サーバーが HTTPS で応答すると、最初の管理者用のセットアップコードを表示します。マシンを確認Linux、x86-64 または ARMポート 80 と 443 が空きDockerなければインストール、確認のうえダウンロードと検証リリースのファイルを、SHA256SUMS で検証いくつかの質問ドメイン、サーバー名、サインイン、メール起動サーバーと Caddy/opt/oleafly-server 内セットアップコードサーバーが応答すると表示されます
1 つのコマンドで、確認、Docker、ダウンロードと検証、いくつかの質問、起動、そしてセットアップコードまで進みます。

実行する前に、次の点を確認してください。

  • マシンが x86-64 または ARM の Linux(Ubuntu 24.04 や Debian 13 など)で、sudo を使えること。
  • マシン上の他のものがポート 80 と 443 を使っていないこと。手前にあるファイアウォールでは、TCP のポート 80 と 443、UDP のポート 443 を開けてください。
  • ドメインの DNS レコードがマシンを指していること。まだ指していなくてもインストールは完了し、レコードが設定されるまで Caddy が証明書の取得を試み続けます。
  • サインインプロバイダを少なくとも 1 つ用意し、その詳細が分かっていること。たとえば GitHub OAuth アプリのクライアント ID とシークレットです。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 に保存します。.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 を 1 つのフォルダにダウンロードします。スクリプトを検証し、内容を読んでから、実行します。

ターミナルウィンドウ
sha256sum --check --ignore-missing SHA256SUMS
sudo sh install.sh

スクリプトやプロビジョニングツールから実行する場合は、--yes を付け、回答を環境変数として渡します。OLEAFLY_INSTALL_DOCKER=yes を指定すると、Docker がない場合にインストーラーが 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 で、コンテナを停止して削除します。尋ねられたときに delete と入力しない限り、データと .env は残ります。それらを削除すると、サーバー上のすべての共有プロジェクト、すべてのアカウント、セキュリティログが消えます。ユーザーのコンピュータには、各自のプロジェクトのコピーが残ります。

インストーラーが解決できない問題で止まった場合は、表示された内容を添えて報告 (新しいタブで開きます)してください。

このセットアップでは、2 つのコンテナを実行します。oleafly-server がサーバーで、ほかのコンテナからしかアクセスできません。caddy は Let’s Encrypt から証明書を取得し、ポート 80 と 443 で HTTPS を提供し、ライブ接続を含むリクエストをサーバーに渡します。

Docker Compose でのデプロイ各コンピュータの Oleafly は、HTTPS でお使いのマシン上の Caddy に接続します。Caddy は証明書を持ち、リクエストを平文の HTTP で oleafly-server コンテナに渡します。サーバーはデータベースとファイルを Docker のデータボリュームに保存し、ファイルを S3 バケットに保存することもできます。Docker Compose を使うマシンOleaflyそれぞれのコンピュータCaddyHTTPS証明書oleafly-server.env の設定データボリュームデータベース、ファイルS3 バケット任意Docker Compose でのデプロイ各コンピュータの Oleafly は、HTTPS でお使いのマシン上の Caddy に接続します。Caddy は証明書を持ち、リクエストを平文の HTTP で oleafly-server コンテナに渡します。サーバーはデータベースとファイルを Docker のデータボリュームに保存し、ファイルを S3 バケットに保存することもできます。Docker Compose を使うマシンOleaflyそれぞれのコンピュータCaddyHTTPS 証明書oleafly-server.env の設定データボリュームデータベース、ファイルS3 バケット任意、ファイル用HTTPSHTTP
Docker Compose: サーバーの前段で Caddy が HTTPS を処理し、データボリュームにデータベースとファイルが入ります。
  1. Docker の手順 (新しいタブで開きます)に従って、Docker Engine と Compose プラグインをインストールします。

  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. sudoedit .env で .env を編集します。OLEAFLY_DOMAIN には https:// を付けないドメインを設定し、OLEAFLY_SERVER_NAME を設定し、サインインプロバイダを少なくとも 1 つ入力します。使わないプロバイダの行は空のままにします。値に $ や # が含まれる場合は、値を一重引用符で囲みます。

  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 は、ufw のようなホストのファイアウォールが有効でも、ポート 80 と 443 を自分で開きます。Caddy に必要なのはそれです。oleafly-server サービスに ports: の項目を追加しないでください。マシン自身からサーバーにアクセスするには、ネットワークに公開されないよう 127.0.0.1:8080:8080 として公開します。

Caddyfile を変更したら、sudo docker compose up -d --force-recreate caddy を実行します。後で更新するには、同じ方法で新しいリリースのファイルをダウンロードし、sudo docker compose up -d をもう一度実行します。

シークレットを保持できる設定は 7 つあります。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 版もあります。2 つのうちどちらか一方だけを設定し、両方は設定しないでください。

たとえば、GitHub のクライアントシークレットを Docker シークレットとして渡すには、docker-compose.yml と同じ場所にある secrets/github_client_secret に保存し、サーバーのユーザー(ID 10001)が読めるようにし、.env から OLEAFLY_GITHUB_CLIENT_SECRET の行を削除します。

ターミナルウィンドウ
sudo chown 10001:10001 secrets/github_client_secret
sudo chmod 400 secrets/github_client_secret

次に、docker-compose.yml と同じ場所に docker-compose.override.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 のリポジトリからサーバーをビルドすることも、ビルドを省略できる公開済みのイメージを実行することもできます。

Coolify でのデプロイ各コンピュータの Oleafly は、必要に応じて Cloudflare を経由して Coolify のプロキシに接続し、プロキシが HTTPS を処理して oleafly-server にリクエストを渡します。サーバーはデータを Docker ボリュームに保存します。Cloudflare が Coolify のプロキシの前段にある場合、すべてのリクエストが 2 つのプロキシを通るため、OLEAFLY_PROXY_HOPS を 2 に設定します。OleaflyそれぞれのコンピュータCloudflare任意Coolify のプロキシHTTPSoleafly-serverお使いの Coolifyサーバーデータボリューム両方が前段にある場合は設定:OLEAFLY_PROXY_HOPS=2Coolify でのデプロイ各コンピュータの Oleafly は、必要に応じて Cloudflare を経由して Coolify のプロキシに接続し、プロキシが HTTPS を処理して oleafly-server にリクエストを渡します。サーバーはデータを Docker ボリュームに保存します。Cloudflare が Coolify のプロキシの前段にある場合、すべてのリクエストが 2 つのプロキシを通るため、OLEAFLY_PROXY_HOPS を 2 に設定します。OleaflyそれぞれのコンピュータCloudflare任意Coolify のプロキシHTTPSoleafly-serverお使いの Coolify サーバーデータボリューム両方が前段にある場合は設定:OLEAFLY_PROXY_HOPS=2
Coolify: そのプロキシが HTTPS を処理します。前段に Cloudflare もある場合は、OLEAFLY_PROXY_HOPS=2 を設定します。

始める前に、collab.example.org などのドメインの DNS レコードを Coolify サーバーに向けます。次に、GitHubの説明に従って GitHub OAuth アプリを作成し、コールバックのアドレスを https://collab.example.org/auth/callback/github にします。クライアント ID とシークレットは手元に控えておきます。

  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 で、Coolify が必須としている OLEAFLY_SERVER_NAME を入力し、続いて 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 を必要とするため拒否されます。

DNS レコードが Cloudflare のプロキシを通る、またはトンネルが Coolify のプロキシにつながるなどの理由で、Coolify の手前に Cloudflare がある場合は、OLEAFLY_PROXY_HOPS を 2 に設定します。設定しないと、セキュリティログにはすべてのユーザーについてプロキシのアドレスが記録され、全員が 1 つのサインイン制限を共有することになります。

Coolify 用のファイルには、GitHub と、UNIVERSITY という名前の OpenID Connect プロバイダ 1 つ分の余地があります。OLEAFLY_OIDC_UNIVERSITY_LABEL には、ユーザーに見せたいテキスト(たとえば GitLab)を設定します。そのコールバックのアドレスは /auth/callback/university で終わります。プロバイダをさらに増やすには、このファイルの自分用のコピーを持つフォークからデプロイします。

データは、名前が oleafly-data で終わる Docker ボリュームにあります。docker volume ls --filter name=oleafly-data で見つけられます。イメージにはシェルがないため、Coolify の Terminal でサーバーのコンテナ内にシェルを開くことはできません。ログとヘルスチェックは通常どおり使えます。

公開済みのイメージをデプロイする

「公開済みのイメージをデプロイする」セクション

公開済みのイメージを実行するとビルドを省略でき、小規模な Coolify サーバーに向いています。上の手順に、2 つの変更を加えて従ってください。手順 2 では、 Docker Compose Location を /deploy/server/docker-compose.coolify-image.yml に設定します。手順 3 は、何もビルドされないため省略します。このファイルは 1 つのリリース系列に従うため、 Redeploy のたびに、その系列の最新リリースが取得されます。

Deploy to Render (新しいタブで開きます) は、Oleafly のリポジトリにある Blueprint を読み込みます。公開済みのイメージから Web サービスを 1 つ作成し、データフォルダ用に 1 GB のディスクを付けます。Render がディスクを接続できるのは有料のインスタンスタイプだけなので、サービスは最も小さい有料のインスタンスで、Render のオレゴンリージョンで起動します。別のリージョンを使うには、render.yaml に region を設定したフォークからデプロイします。

  1. リンクを開き、Render にサインインします。
  2. Render に OLEAFLY_SERVER_NAME と、GitHub のクライアント ID とシークレットの入力を求められます。名前を入力し、GitHub の欄は今は空のままにします。そのコールバックのアドレスはサービスのアドレスによって決まりますが、まだそのアドレスがないためです。
  3. Deploy Blueprint を選びます。サービスが公開されると、そのページに https://oleafly-server.onrender.com のようなアドレスが表示されます。Blueprint は OLEAFLY_PUBLIC_URL をそのアドレスに設定します。
  4. GitHubの説明に従って GitHub OAuth アプリを作成し、コールバックのアドレスには、そのアドレスに /auth/callback/github を続けたものを指定します。クライアント ID とシークレットは、サービスの Environment に追加します。Render は、それらを設定してサーバーを再起動します。
  5. サービスの Logs で最新の Setup code: の行を見つけ、最初の管理者になります。

サービスに独自のドメインを割り当てる場合は、 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. 変更をデプロイします。サービスの Deploy Logs で最新の Setup code: の行を見つけ、最初の管理者になります。

Docker のないマシンでは、サーバーは systemd の下で単一のプログラムとして動作し、HTTPS のために手前に Caddy を置きます。

Docker なしの Linux でのデプロイ各コンピュータの Oleafly は、HTTPS でお使いの Linux マシン上の Caddy に接続します。Caddy はリクエストを oleafly-server に渡します。oleafly-server は systemd サービスとして 127.0.0.1 のポート 8080 で待ち受け、データを /var/lib/oleafly-server に保存します。お使いの Linux マシンOleaflyそれぞれのコンピュータCaddyHTTPS証明書oleafly-serversystemd サービスデータフォルダ/var/lib/oleafly-serverDocker なしの Linux でのデプロイ各コンピュータの Oleafly は、HTTPS でお使いの Linux マシン上の Caddy に接続します。Caddy はリクエストを oleafly-server に渡します。oleafly-server は systemd サービスとして 127.0.0.1 のポート 8080 で待ち受け、データを /var/lib/oleafly-server に保存します。お使いの Linux マシンOleaflyそれぞれのコンピュータCaddyHTTPS 証明書oleafly-serversystemd サービスデータフォルダ/var/lib/oleafly-serverHTTPSHTTP
Docker なしの Linux: systemd がサーバーを動かし、前段の Caddy が HTTPS を処理します。

リリースページ (新しいタブで開きます)にあるサーバーのリリースには、x86-64 用と ARM 用のビルド済みプログラムと、それを検証するための SHA256SUMS ファイルが含まれています。このプログラムの実行に、ほかに何もインストールする必要はありません。

お使いのマシン用のアーカイブ(名前が x86_64-unknown-linux-musl.tar.gz または aarch64-unknown-linux-musl.tar.gz で終わるもの)と SHA256SUMS を、1 つのフォルダにダウンロードします。その後、検証してインストールします。ARM のマシンでは、x86_64 の代わりに aarch64 を使います。

ターミナルウィンドウ
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 が含まれています。

プログラムを自分でビルドする場合は、Docker が使えるコンピュータで、Oleafly リポジトリのクローンから次を実行します。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

    1 行に 1 つ設定を書きます。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 の credential を使います。シークレットを /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、または大学がすでに運用している Web サーバーを使う場合は、リバースプロキシの内側で動かすをお読みください。

マシンに公開アドレスがない場合(たとえば、大学のファイアウォールの内側にある研究室のコンピュータ)は、Cloudflare Tunnel でアクセスできるようにできます。ドメインを登録した Cloudflare アカウントが必要です。Cloudflare がそのホスト名の HTTPS を処理するため、リクエストはマシンに届く前に、Cloudflare のネットワーク上で復号されます。サーバーへの通信を読める当事者の中に、Cloudflare も含めて考えてください。

Cloudflare Tunnel でのデプロイ各コンピュータの Oleafly は、HTTPS で Cloudflare に接続します。お使いのマシン上の cloudflared コンテナが Cloudflare に向けてトンネルを開くため、マシンに公開アドレスは必要ありません。リクエストはトンネルを通って cloudflared に届き、cloudflared が oleafly-server に渡します。お使いのマシン(公開アドレスなし)OleaflyそれぞれのコンピュータCloudflareHTTPScloudflaredトンネルを開くoleafly-serverデータボリュームCloudflare Tunnel でのデプロイ各コンピュータの Oleafly は、HTTPS で Cloudflare に接続します。お使いのマシン上の cloudflared コンテナが Cloudflare に向けてトンネルを開くため、マシンに公開アドレスは必要ありません。リクエストはトンネルを通って cloudflared に届き、cloudflared が oleafly-server に渡します。お使いのマシン(公開アドレスなし)OleaflyそれぞれのコンピュータCloudflareHTTPScloudflaredトンネルを開くoleafly-serverデータボリュームトンネル
Cloudflare Tunnel: マシン側からトンネルを開くので、公開アドレスは不要です。
  1. Docker Compose を手動で使うの手順を、.env の編集まで行います。OLEAFLY_DOMAIN には、使用するホスト名(collab.example.org など)を設定します。1 つのコマンドで行うインストーラーは 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 のないマシンでは、Cloudflare のパッケージリポジトリ (新しいタブで開きます)から cloudflared をインストールし、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 も設定します。Cloudflare の Free プランと Pro プランでは、100 MB を超えるリクエストが拒否されるため、OLEAFLY_MAX_PROJECT_MB を 100 以下に設定してください。そうしないと、大きなプロジェクトのアップロードに失敗します。Oleafly はログインページを通過できないため、サーバーの手前に Cloudflare Access を置かないでください。

後でサーバーを更新するときは、新しいリリースのファイルをダウンロードし、Caddy を起動しないようにサービス名を指定します。sudo docker compose up -d oleafly-server です。

新しいサーバーには管理者がいません。誰かがセットアップを完了するまで、サーバーは起動のたびに新しい 1 回限りのセットアップコードを作り、ログに書き込みます。

  1. ログで、Setup code: で始まる最新の行を探します。
    • 1 つのコマンドでのインストール:インストーラーが終了時に表示します。もう一度表示するには、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 とだけ表示されるので、自分で設定した値を入力します。セットアップが終わったら、設定から削除してください。

次に、ユーザーを入れます。方法はサインインとアクセスで説明しています。

  • 1 つのコマンドでインストールした場合、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、バージョン、ライブ接続、サインイン方法、サーバーの時計を確認できます。管理コンソールの接続チェックでも、同じチェックを実行できます。
画像のプレビュー

AI の回答を読み込めませんでした

もう一度試すか、ドキュメントを検索してください。