Docs / はじめに

Quick Start

公開済みのDocker imageを使ってVylineを起動します。ここでは標準Composeの設定値を基準にします。

非公式クライアント

VylineはLINE公式・承認済みクライアントではありません。アカウントやデータへの影響を理解した上で使用してください。

必要なもの

64-bitのDockerホスト。公開imageはlinux/amd64とlinux/arm64をbuildしています。
Docker EngineとDocker Compose v2。
永続データを置くストレージ。

1. Composeを取得

mkdir -p vyline && cd vyline
curl -LO https://raw.githubusercontent.com/tqmane/vyline/main/docker-compose.yml
docker compose pull
docker compose up -d

標準Composeのimageは ghcr.io/tqmane/vyline:latest。container内のlisten portは3000で、Host側も既定で3000へpublishします。

2. ブラウザで開く

http://127.0.0.1:3000

標準ComposeのVYLINE_BIND_ADDRESS既定値は0.0.0.0ですが、VYLINE_LAN_ACCESSは既定でfalseです。backendは非loopbackからの未認証アクセスを拒否します。

loopbackだけにbindする場合

.envへVYLINE_BIND_ADDRESS=127.0.0.1を設定し、containerを再作成します。

3. データを守る

標準ComposeはHost側の./dataを/app/dataへ、./storageを/app/storageへbind mountします。

Host側の2ディレクトリは削除しない

data/にはセッション、設定、チャットDB、バックアップ等、storage/には保存メディアとcache等が入ります。

4. 確認

docker compose ps
docker compose logs --tail=100

imageには/healthzを使うhealthcheckが設定されています。更新時はdocker compose pull && docker compose up -dでimageを取得して再作成します。

次に読む

通常サーバー: Linux
Raspberry Pi: Raspberry Pi
Android端末: Android
Portainer: Portainer
外部公開: Remote Access