Arkvory

クイックスタート ​

このページでは、何もない状態から、1つのファイルをアップロードした稼働中のArkvoryサーバーまでの、最短の手順を説明します。ステップ1でインストール方法を1つ選び、残りのステップを順番に進めてください。

インストーラーは、必ずプロジェクトのリリースページからダウンロードし、SHA-256をリリースのチェックサムファイルと照合してください。

ステップ1：サーバーをインストールする ​

Windows ​

Windows 10 バージョン1809以降、またはWindows Server 2019以降（x64）と、管理者権限が必要です。インターネット接続は不要です。

  1. Arkvory-Setup-x64.exeを実行し、管理者の確認ダイアログを承認します。
  2. 言語を選択し、ライセンスに同意します。
  3. 所有者のページで、名前（英字（ラテン文字）、数字、.、-、_を使った3〜64文字）と、12文字以上のパスワードを入力します。これが最初の管理者アカウントです。
  4. ウィザードを完了します。コンソールを自動で開くこともできます。

セットアップは、プログラムをC:\Program Files\ProAnima\Arkvoryに、データをC:\ProgramData\ProAnima\Arkvoryにインストールします。また、Arkvorydatabase、Arkvoryapi、Arkvoryworker、Arkvorybackupの4つのWindowsサービスを作成します。これらは、サインインしているユーザーがいなくても実行されます。詳しくはWindowsを参照してください。

Linux ​

ディストリビューションに合ったパッケージを使います。パッケージマネージャーが、PostgreSQLサーバーもインストールします（バージョン16〜19に対応）。

bash
# Debian、Ubuntu
sudo apt install ./Arkvory-amd64.deb

# Fedora、RHEL互換
sudo dnf install ./Arkvory-x86_64.rpm

インストールルートは/opt/proanima-arkvoryです。パッケージはsystemdサービスarkvory-database、arkvory-api、arkvory-worker、arkvory-backupを作成します。次のコマンドで状態を確認します。

bash
systemctl status arkvory-api arkvory-worker arkvory-backup

詳しくはLinuxを参照してください。

Docker Compose ​

Composeに対応したDockerが必要です。Windowsでは、LinuxコンテナーモードのDocker Desktopを使います。スクリプトはNode.jsとリリースをダウンロードするため、インターネットに接続できる必要があります。

リリースからinstall.shまたはinstall.ps1をダウンロードし、実行する前に内容を確認してください。

bash
sudo bash ./install.sh --mode compose

Windowsでは、Docker Desktopを実行しているのと同じユーザーで、管理者権限なしでPowerShellを実行します。

powershell
.\install.ps1 -Mode compose

インストールルートは、Linuxでは/opt/proanima-arkvory、WindowsではC:\ProgramData\ProAnima\Arkvoryです。スタックには、API、ワーカー、バックアップエージェント、PostgreSQL 18が含まれます。詳しくはDockerを参照してください。

ステップ2：コンソールを開く ​

サーバー上のブラウザーでhttp://127.0.0.1:8080/console/を開きます。

最初のうち、サーバーはローカルアドレス127.0.0.1でのみ待ち受けます。自分のコンピューターからコンソールを開くには、SSH経由でポートを転送します。

bash
ssh -L 8080:127.0.0.1:8080 admin@arkvory.example

続いて、自分のコンピューターでhttp://127.0.0.1:8080/console/を開きます。他のマシンにアクセスを許可するには、先にHTTPSを設定してください。

ステップ3：所有者を作成する ​

Windowsでは、このステップは不要です。セットアップが所有者をすでに作成しています。

LinuxとDockerでは、最初のアカウントを回復キーで作成します。インストーラーが、インストールルートのconfig/bootstrap-token.txtにキーを書き込みます。このファイルを読めるのは管理者だけです。

bash
sudo cat /opt/proanima-arkvory/config/bootstrap-token.txt
powershell
Get-Content C:\ProgramData\ProAnima\Arkvory\config\bootstrap-token.txt
  1. コンソールではじめにを開き、最初の所有者を作成を展開します。
  2. 回復キーにキーを貼り付けます。
  3. 所有者の名前と12文字以上のパスワードを入力し、所有者を作成を選択します。
  4. リポジトリへの接続カードで、新しい名前とパスワードを使ってサインインします。

回復キーは秘密にし、ファイルは削除しないでください。インストールと更新のツールがこのファイルを使用します。セキュリティを参照してください。

所有者は管理者であり、リポジトリreleasesに書き込めます。別のリポジトリを作成するには、ユーザーとアクセスを開き、リポジトリアクセスの管理を展開して、グループarkvory-ownersに、buildsなどの新しい名前に対する読み取りと書き込みのアクセス権を付与し、アクセス権を保存を選択します。リポジトリ名には、小文字の英字（ラテン文字）、数字、-、_を使用でき、最大64文字です。

ステップ4：ツール用のキーを作成する ​

スクリプトとコマンドラインクライアントにはキーが必要です。最初のテストでは、個人用アクセストークンを使います。

  1. リポジトリへの接続カードで個人用アクセストークンを展開します。
  2. トークン名を入力し、アクセスを読み取りと書き込みに設定して、トークンを生成を選択します。
  3. トークンをコピーします。表示されるのは1回だけです。
  4. 自分だけが読めるファイル（例：~/.arkvory/key）に保存します。

CI/CDやデプロイエージェントには、代わりに専用のキーを持つサービスアカウントを作成します。アカウントとアクセスを参照してください。

ステップ5：curlでアップロードとダウンロードを行う ​

リポジトリ内のファイルパスは、Webサーバー上のファイルのように機能します。PUTでパスの新しいバージョンを保存し、GETで現在のバージョンを取得します。

bash
export ARKVORY_KEY="$(cat ~/.arkvory/key)"

# アップロード
curl -T ./Setup.exe -H "Authorization: Bearer $ARKVORY_KEY" \
  http://127.0.0.1:8080/api/v1/repositories/releases/raw/builds/game/1.0/Setup.exe

# ダウンロード
curl -fL -H "Authorization: Bearer $ARKVORY_KEY" -o Setup-copy.exe \
  http://127.0.0.1:8080/api/v1/repositories/releases/raw/builds/game/1.0/Setup.exe

アップロードすると、次のようなJSONが返されます。

json
{
  "path": "builds/game/1.0/Setup.exe",
  "revision": 1,
  "created": true,
  "artifact": { "id": "…", "size": "1048576", "sha256": "…" }
}

同じバイト列をもう一度アップロードすると、応答は200と"created": falseになり、新しいバージョンは作成されません。新しいファイルのステータスは201です。

PowerShellの場合は次のとおりです。

powershell
$headers = @{ Authorization = "Bearer $env:ARKVORY_KEY" }
$url = 'http://127.0.0.1:8080/api/v1/repositories/releases/raw/builds/game/1.0/Setup.exe'
Invoke-WebRequest -Method Put -InFile .\Setup.exe -Headers $headers -Uri $url
Invoke-WebRequest -Headers $headers -Uri $url -OutFile .\Setup-copy.exe

1回のPUTリクエストは、30分以内に完了する必要があります。非常に大きなファイルや低速なネットワークでは、コマンドラインクライアントを使ってください。パートに分けてアップロードし、失敗後も続行できます。Rawファイルを参照してください。

ステップ6：コマンドラインクライアントを使う ​

自分のコンピューターにarkvoryctlをインストールします。WindowsではArkvory-CLI-Setup-x64.exe、LinuxではArkvory-CLI-amd64.debまたはArkvory-CLI-x86_64.rpmです。Node.js 24があるCIマシンでは、arkvoryctl.mjsも使えます。

bash
arkvoryctl profile add local --server http://127.0.0.1:8080 --token-file ~/.arkvory/key
arkvoryctl doctor
arkvoryctl put ./Setup.exe builds/game/1.0/Setup.exe
arkvoryctl get builds/game/1.0/Setup.exe ./Setup-copy.exe

プロファイルは、--repositoryを指定しない限り、リポジトリreleasesを使います。転送が中断した場合は、同じコマンドをもう一度実行してください。中断した位置から続行し、最後にSHA-256を確認します。クライアントが平文のHTTPを受け付けるのは、ローカルコンピューターに対してだけです。リモートサーバーにはHTTPSを使ってください。詳しくはコマンドラインクライアントを参照してください。

次のステップ ​

Arkvory · ProAnimaStudio