SnapOtterandGitHub
5f21588f6c
Bumps every version surface to 2.2.0, fixes a latent version-coupling bug in the OCR runtime tests, and stops an absent GPU runner from silently stalling a release. Version surfaces: scripts/sync-version.sh covers the 11 workspaces, APP_VERSION, and the docs release commands across all locales. Root package.json plus the three surfaces the script never reaches are done by hand: the DOCKERHUB.md banner and tag table, the docker-tags.md pinning table in 21 locales, and the example runtimeVersion in tools/image/ocr.md in 21 locales. The release-notes archive step is deliberately not pre-run, so the notes text stays editable until the release. Latent bug: runtime-state rejects any runtime whose compatibility.snapotterVersion is not exactly APP_VERSION, and five fixtures pinned the literal 2.1.0. Since semantic-release rewrites APP_VERSION on every release, the first PR after any bump would have gone red for a reason nobody would trace to the release. The fixtures now derive from APP_VERSION. GPU runner: sign-ocr-index needs verify-ocr-nvidia on self-hosted hardware, and the gated manifest job needs ai-bundles, so a missing runner queued instead of failing and produced no image tags. preflight-gpu-runner claims the same labels with no dependencies, so it is scheduled first and validates the GPU before the 90-minute build. An API preflight is impossible because listing self-hosted runners needs Administration:read, which GITHUB_TOKEN cannot hold, so RELEASE.md carries the maintainer-side check.
8.9 KiB
description, i18n_source_hash, i18n_provenance, i18n_output_hash, i18n_hash_version
| description | i18n_source_hash | i18n_provenance | i18n_output_hash | i18n_hash_version |
|---|---|---|---|---|
| Cài đặt SnapOtter với Docker trong một lệnh. Bao gồm thiết lập Docker Compose, build từ mã nguồn, và tổng quan đầy đủ về tính năng. | 8040133a6982 | machine | 35795f26270f | 2 |
Bắt đầu
::: tip Dùng thử trước khi cài đặt Khám phá toàn bộ giao diện tại demo.snapotter.com, không cần đăng ký hay cài đặt. :::
Bắt đầu nhanh
docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest
Vùng chứa duy nhất này chạy mọi thứ nó cần: không có bộ DATABASE_URL, nó khởi động PostgreSQL và Redis của riêng nó trên giao diện loopback (chế độ nhúng) và giữ tất cả dữ liệu trong ổ SnapOtter-data. Đây là cách nhanh nhất để dùng thử SnapOtter hoặc tự lưu trữ trên homelab. Để sản xuất, hãy sử dụng ngăn xếp Docker Compose chuẩn, để giữ PostgreSQL và Redis trong các vùng chứa riêng của chúng. Chế độ nhúng chạy bằng root (mặc định) và tự động tắt ngay khi bạn đặt DATABASE_URL.
Cài đặt trên Raspberry Pi, laptop cũ, hay một VPS nhỏ? Xem Thiết lập trên phần cứng hạn chế để có hướng dẫn từng bước đã tinh chỉnh và biết nên kỳ vọng gì từ phần cứng hạn chế.
Bạn sẽ được yêu cầu đổi mật khẩu ở lần đăng nhập đầu tiên.
::: tip Phân tích sản phẩm ẩn danh SnapOtter bao gồm phân tích sản phẩm ẩn danh theo mặc định. Để tắt nó, mở Settings → System → Privacy và tắt Anonymous Product Analytics. Nó dừng ngay lập tức cho toàn bộ instance.
Bạn cũng có thể đặt biến môi trường SNAPOTTER_TELEMETRY=0 (false và off cũng hoạt động) để tắt toàn bộ telemetry cho instance mà không cần xây dựng lại.
Việc giám sát lỗi được cung cấp bởi Sentry, đơn vị tài trợ cho SnapOtter thông qua chương trình mã nguồn mở của họ.
Để biết chi tiết về những gì được thu thập, xem SnapOtter thu thập gì. :::
::: tip Tăng tốc NVIDIA CUDA
Thêm --gpus all để loại bỏ nền, nâng cấp, nâng cấp và phục hồi khuôn mặt được tăng tốc CUDA của NVIDIA. OCR vẫn dựa trên CPU và hoạt động trong cùng một hình ảnh có hoặc không có quyền truy cập GPU:
docker run -d --name SnapOtter -p 1349:1349 --gpus all -v SnapOtter-data:/data snapotter/snapotter:latest
Yêu cầu Bộ công cụ bộ chứa NVIDIA. Tự động quay trở lại CPU khi CUDA không khả dụng. Hiện nay, khả năng tăng tốc iGPU của Intel/AMD thông qua VA-API, Quick Sync hoặc OpenCL không được hỗ trợ cho suy luận AI. Xem Thẻ Docker để biết điểm chuẩn. Nếu các công cụ AI chạy trên CPU mặc dù có --gpus all, hãy xem Xác minh khả năng tăng tốc GPU.
:::
::: details Cũng có trên GHCR
docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data ghcr.io/snapotter-hq/snapotter:latest
Cả hai registry đều phát hành cùng một image trong mỗi bản phát hành. :::
Docker Soạn
Sử dụng tệp sản xuất được duy trì và thử nghiệm với mỗi bản phát hành thay vì sao chép ví dụ Compose viết tắt từ trang này:
install -d -m 700 snapotter && cd snapotter
curl --proto '=https' --tlsv1.2 -fsSLo docker-compose.yml \
https://raw.githubusercontent.com/snapotter-hq/SnapOtter/v2.2.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 chuẩn bao gồm tất cả bốn khối thời gian chạy, kiểm tra tình trạng, giới hạn tài nguyên, cấu hình Redis bền vững, hình ảnh bộ đệm/cơ sở dữ liệu được ghim và tăng cường vùng chứa hiện tại. Thay đổi mật khẩu quản trị mặc định ngay sau lần đăng nhập đầu tiên. Để triển khai có thể lặp lại, hãy ghim hình ảnh ứng dụng SnapOtter vào thẻ phát hành hoặc thông báo mà bạn đã xác minh thay vì theo dõi latest.
Xem Cấu hình để biết tất cả các biến môi trường và Bảo mật & tăng cường để biết bí mật, chính sách mạng và hướng dẫn sao lưu.
Build từ mã nguồn
Điều kiện tiên quyết: Node.js 22.22+, pnpm 9+, Docker (cho Postgres + Redis), Python 3.11+ (cho các tính năng AI), Git.
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
- Frontend: http://localhost:1351
- Backend: http://localhost:13490
Những gì bạn có thể làm
Xử lý tập tin (200+ công cụ)
| Phương thức | Số lượng | Công cụ ví dụ |
|---|---|---|
| Hình ảnh | 107 | Thay đổi kích thước, Cắt, Nén, Chuyển đổi, Xóa nền, Nâng cấp độ phân giải, OCR, Đóng dấu, Ghép ảnh, Tô màu, Công cụ GIF, preset định dạng |
| Video | 57 | Cắt, Cắt khung, Nén, Chuyển đổi, Gộp, Trích xuất âm thanh, Phụ đề tự động, Video sang GIF, Thay đổi kích thước, Ổn định, preset định dạng |
| Âm thanh | 27 | Cắt, Gộp, Chuyển đổi, Chuẩn hóa, Giảm nhiễu, Phiên âm, Dịch cao độ, Fade, Tạo nhạc chuông, preset định dạng |
| PDF / Tài liệu | 29 | Gộp, Tách, Nén, OCR, Đóng dấu, Che thông tin, Word sang PDF, Excel sang PDF, Xoay, Bảo vệ, Sửa chữa |
| Tập tin | 23 | CSV sang JSON, JSON sang XML, Gộp CSV, Tách CSV, Tạo ZIP, Giải nén ZIP, Tạo biểu đồ, YAML/JSON |
Pipeline
Ghép chuỗi các công cụ thành các quy trình nhiều bước và áp dụng chúng cho một hình ảnh hoặc cả một lô:
- Mở Pipelines ở thanh bên.
- Thêm các bước (công cụ bất kỳ, cài đặt bất kỳ).
- Chạy trên một tập tin đơn, hoặc cả một lô cùng lúc.
- Lưu pipeline để tái sử dụng sau này.
Pipeline cho phép 20 bước theo mặc định. Đặt MAX_PIPELINE_STEPS=0 để giới hạn thành không giới hạn.
Thư viện tập tin
Mọi tập tin bạn xử lý đều có thể được lưu vào thư viện Files của bạn. SnapOtter theo dõi toàn bộ lịch sử phiên bản để bạn có thể lần theo mọi bước xử lý từ tải lên gốc đến kết quả cuối cùng.
Việc lưu là tường minh: các kết quả bạn lưu vào thư viện được giữ lại cho đến khi bạn xóa chúng, trong khi các kết quả bạn xử lý và để chưa lưu sẽ tự động bị xóa sau 72 giờ (có thể cấu hình thông qua FILE_MAX_AGE_HOURS).
REST API & API Key
Mọi công cụ đều có thể truy cập qua HTTP:
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"}'
Tạo API key trong mục Settings → API Keys. Xem tham chiếu REST API để biết tất cả các endpoint, hoặc truy cập http://localhost:1349/api/docs để có tham chiếu tương tác.
Đa người dùng & Nhóm
Bật nhiều người dùng với kiểm soát truy cập dựa trên vai trò:
- Admin: toàn quyền, quản lý người dùng, nhóm, cài đặt, tất cả tập tin/pipeline/API key
- User: dùng công cụ, quản lý tập tin/pipeline/API key của riêng mình
Tạo các nhóm trong mục Settings → Teams để nhóm người dùng lại.
Đặt AUTH_ENABLED=true (hoặc false cho trường hợp một người dùng/tự sử dụng mà không cần đăng nhập).