mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtterandGitHub
d10d0f544f
A release-readiness QA pass over the whole product. The commits split into defects a user would hit and gates that were reporting green while measuring nothing. ## Fixes that change behaviour Rate limiting was bypassable on every install: TRUST_PROXY defaulted to true, so request.ip came from a client-set header and a forged X-Forwarded-For got past the login limiter. The default is now a private-network trust list. A transient Postgres outage stranded in-flight jobs, leaving finished output on disk with no row pointing at it. A reconciler now resolves those rows and adopts the bytes rather than dropping the work. A Redis connection that moved to a new address wedged every read-blocked consumer, so completions stopped signalling while health still answered 200. Socket timeouts plus subscriber pings recover it. Installing more than one AI bundle left the shared venv multi-versioned and silently broke three tools. The installer now reconciles distributions to one version each. Converting an image to JXL at quality 1 through 4 returned a 500, because libjxl 0.7 rejects the distance those values compute. The quality is floored at what the encoder honours. A missing ffmpeg was also reported to the user as a corrupt upload; it now says the engine is unavailable. RAW uploads reached an unpatched LibRaw on arm64, so it is built from source at 0.22.2, and the release scan was split so it can fail on an unfixed critical instead of hiding it behind ignore-unfixed. ## Gates that could not fail Two mutation lanes ran zero mutants because Stryker crawled the gitignored docs build; coverage discarded its whole report on any failing test; the lint gate skipped root tests, scripts, and two workspaces; and several generated matrices counted a host missing ffmpeg as a passing tool. Each now measures what it claims. Full evidence and the outstanding release items are tracked locally and are not part of this branch.
146 lines
9.7 KiB
Markdown
146 lines
9.7 KiB
Markdown
---
|
||
description: "1 つのコマンドで SnapOtter を Docker でインストールします。Docker Compose のセットアップ、ソースからのビルド、機能の全体像を含みます。"
|
||
i18n_source_hash: 8040133a6982
|
||
i18n_provenance: machine
|
||
i18n_output_hash: 254b9e41e358
|
||
i18n_hash_version: 2
|
||
---
|
||
|
||
# はじめに {#getting-started}
|
||
|
||
::: tip インストール前に試す
|
||
[demo.snapotter.com](https://demo.snapotter.com) で完全な UI を試せます。サインアップもインストールも不要です。
|
||
:::
|
||
|
||
## クイックスタート {#quick-start}
|
||
|
||
```bash
|
||
docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest
|
||
```
|
||
|
||
この単一のコンテナーは必要なものをすべて実行します。`DATABASE_URL` を設定せずに、ループバック インターフェイス (埋め込みモード) で独自の PostgreSQL と Redis を開始し、すべてのデータを `SnapOtter-data` ボリュームに保持します。これは、ホームラボで SnapOtter またはセルフホストを試す最も速い方法です。運用環境では、PostgreSQL と Redis を独自のコンテナーに保持する [正規の Docker Compose スタック](#docker-compose) を使用します。埋め込みモードは root (デフォルト) として実行され、`DATABASE_URL` を設定するとすぐに自動的にオフになります。
|
||
|
||
Raspberry Pi、古いラップトップ、小さな VPS にインストールしますか？調整済みの手順と、限られたハードウェアで何が期待できるかについては、[低リソース環境のセットアップ](/ja/guide/low-resource) を参照してください。
|
||
|
||
初回ログイン時にパスワードの変更を求められます。
|
||
|
||
::: tip 匿名のプロダクトアナリティクス
|
||
SnapOtter にはデフォルトで匿名のプロダクトアナリティクスが含まれています。オフにするには、**Settings → System → Privacy** を開き、**Anonymous Product Analytics** をオフにしてください。インスタンス全体で即座に停止します。
|
||
|
||
環境変数 `SNAPOTTER_TELEMETRY=0`（`false` と `off` も使えます）を設定すると、リビルドせずにインスタンスのすべてのテレメトリを無効にできます。
|
||
|
||
エラー監視は [Sentry](https://sentry.io) によって提供されており、Sentry はオープンソースプログラムを通じて SnapOtter をスポンサーしています。
|
||
|
||
何が収集されるかの詳細については、[SnapOtter が収集するもの](/ja/guide/telemetry) を参照してください。
|
||
:::
|
||
|
||
::: tip NVIDIA CUDA アクセラレーション
|
||
NVIDIA CUDA で高速化された背景除去、アップスケーリング、顔の強調、および復元用に `--gpus all` を追加します。 OCR は CPU ベースのままで、GPU アクセスの有無にかかわらず、同じイメージ内で動作します。
|
||
|
||
```bash
|
||
docker run -d --name SnapOtter -p 1349:1349 --gpus all -v SnapOtter-data:/data snapotter/snapotter:latest
|
||
```
|
||
|
||
[NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) が必要です。 CUDA が使用できない場合は、自動的に CPU にフォールバックします。現在、VA-API、Quick Sync、または OpenCL を介した Intel/AMD iGPU アクセラレーションは AI 推論ではサポートされていません。ベンチマークについては、[Docker タグ](/ja/guide/docker-tags) を参照してください。 `--gpus all` にもかかわらず AI ツールが CPU で実行される場合は、[GPU アクセラレーションを検証する](/ja/guide/deployment#verify-gpu-acceleration) を参照してください。
|
||
:::
|
||
|
||
::: details GHCR でも利用可能
|
||
```bash
|
||
docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data ghcr.io/snapotter-hq/snapotter:latest
|
||
```
|
||
|
||
どちらのレジストリもリリースごとに同じイメージを公開します。
|
||
:::
|
||
|
||
## Docker Compose {#docker-compose}
|
||
|
||
このページから短縮された Compose サンプルをコピーする代わりに、各リリースで保守およびテストされた実稼働ファイルを使用してください。
|
||
|
||
```bash
|
||
install -d -m 700 snapotter && cd snapotter
|
||
curl --proto '=https' --tlsv1.2 -fsSLo docker-compose.yml \
|
||
https://raw.githubusercontent.com/snapotter-hq/SnapOtter/v2.1.0/docker/docker-compose.yml
|
||
|
||
# Keep generated service credentials out of shell history and world-readable files.
|
||
umask 077
|
||
POSTGRES_PASSWORD="$(openssl rand -hex 32)"
|
||
REDIS_PASSWORD="$(openssl rand -hex 32)"
|
||
printf 'POSTGRES_PASSWORD=%s\nREDIS_PASSWORD=%s\n' \
|
||
"$POSTGRES_PASSWORD" "$REDIS_PASSWORD" > .env
|
||
|
||
docker compose -f docker-compose.yml pull
|
||
docker compose -f docker-compose.yml up -d --no-build
|
||
```
|
||
|
||
正規の [`docker/docker-compose.yml`](https://github.com/snapotter-hq/SnapOtter/blob/v2.1.0/docker/docker-compose.yml) には、4 つのランタイム ボリュームすべて、ヘルス チェック、リソース制限、耐久性のある Redis 構成、固定されたデータベース/キャッシュ イメージ、および現在のコンテナーの強化が含まれています。最初のログイン直後にデフォルトの管理者パスワードを変更します。再現可能な展開を行うには、`latest` をフォローする代わりに、SnapOtter アプリケーション イメージをリリース タグまたは確認したダイジェストに固定します。
|
||
|
||
すべての環境変数については [構成](/ja/guide/configuration) を、シークレット、ネットワーク ポリシー、およびバックアップ ガイダンスについては [セキュリティと強化](/ja/guide/security) を参照してください。
|
||
|
||
## ソースからビルド {#build-from-source}
|
||
|
||
**前提条件:** Node.js 22.22 以上、pnpm 9 以上、Docker（Postgres + Redis 用）、Python 3.10 以上（AI 機能用）、Git。
|
||
|
||
```bash
|
||
git clone https://github.com/snapotter-hq/SnapOtter.git
|
||
cd SnapOtter
|
||
docker compose -f docker-compose.dev.yml up -d # start Postgres + Redis
|
||
pnpm install
|
||
pnpm dev
|
||
```
|
||
|
||
- フロントエンド: [http://localhost:1351](http://localhost:1351)
|
||
- バックエンド: [http://localhost:13490](http://localhost:13490)
|
||
|
||
## できること {#what-you-can-do}
|
||
|
||
### ファイル処理（200+ ツール） {#file-processing-200-tools}
|
||
|
||
| モダリティ | 数 | ツールの例 |
|
||
|----------|-------|---------------|
|
||
| **画像** | 107 | リサイズ、切り抜き、圧縮、変換、背景除去、アップスケール、OCR、透かし、コラージュ、カラー化、GIF ツール、フォーマットプリセット |
|
||
| **ビデオ** | 57 | トリミング、切り抜き、圧縮、変換、結合、オーディオ抽出、自動字幕、ビデオから GIF、リサイズ、手ブレ補正、フォーマットプリセット |
|
||
| **オーディオ** | 27 | トリミング、結合、変換、正規化、ノイズ低減、文字起こし、ピッチシフト、フェード、着信音メーカー、フォーマットプリセット |
|
||
| **PDF / ドキュメント** | 29 | 結合、分割、圧縮、OCR、透かし、墨消し、Word から PDF、Excel から PDF、回転、保護、修復 |
|
||
| **ファイル** | 23 | CSV から JSON、JSON から XML、CSV の結合、CSV の分割、ZIP の作成、ZIP の展開、チャートメーカー、YAML/JSON |
|
||
|
||
### パイプライン {#pipelines}
|
||
|
||
ツールを連結して複数ステップのワークフローにし、1 枚の画像やバッチ全体に適用します：
|
||
|
||
1. サイドバーで **Pipelines** を開きます。
|
||
2. ステップを追加します（任意のツール、任意の設定）。
|
||
3. 単一ファイルで実行するか、バッチ全体を一度に実行します。
|
||
4. パイプラインを保存して後で再利用します。
|
||
|
||
パイプラインはデフォルトで 20 ステップを許可します。`MAX_PIPELINE_STEPS=0` を設定すると上限を無制限にできます。
|
||
|
||
### ファイルライブラリ {#file-library}
|
||
|
||
処理したすべてのファイルは **Files** ライブラリに保存できます。SnapOtter は完全なバージョン履歴を追跡するので、元のアップロードから最終出力まで、あらゆる処理ステップを辿れます。
|
||
|
||
保存は明示的です。ライブラリに保存した結果は削除するまで保持されますが、処理して未保存のまま残した結果は 72 時間後に自動的に消去されます（`FILE_MAX_AGE_HOURS` で設定可能）。
|
||
|
||
### REST API と API キー {#rest-api-api-keys}
|
||
|
||
すべてのツールは HTTP 経由でアクセスできます：
|
||
|
||
```bash
|
||
curl -X POST http://localhost:1349/api/v1/tools/image/resize \
|
||
-H "Authorization: Bearer si_<your-api-key>" \
|
||
-F "file=@photo.jpg" \
|
||
-F 'settings={"width":800,"height":600,"fit":"cover"}'
|
||
```
|
||
|
||
**Settings → API Keys** で API キーを生成します。すべてのエンドポイントについては [REST API リファレンス](/ja/api/rest) を参照するか、[http://localhost:1349/api/docs](http://localhost:1349/api/docs) でインタラクティブなリファレンスにアクセスしてください。
|
||
|
||
### マルチユーザーとチーム {#multi-user-teams}
|
||
|
||
ロールベースのアクセス制御で複数のユーザーを有効にします：
|
||
|
||
- **管理者（Admin）**: フルアクセス。ユーザー、チーム、設定、すべてのファイル/パイプライン/API キーを管理します
|
||
- **ユーザー（User）**: ツールを使用し、自分のファイル/パイプライン/API キーを管理します
|
||
|
||
**Settings → Teams** でチームを作成してユーザーをグループ化します。
|
||
|
||
`AUTH_ENABLED=true`（ログインなしの単一ユーザー/自己利用の場合は `false`）を設定します。
|