Chuyển tới nội dung chính

Tự triển khai

Chạy ReleaseFlow trên hạ tầng bạn đã tin tưởng.

Một ứng dụng Spring Boot và một database PostgreSQL, khởi động bằng Docker Compose. Mọi người đều chạy cùng mã nguồn Apache-2.0: không có hosted control plane, không có bản enterprise, không chia open-core.

  • Docker Compose v2
  • Java 21 · Spring Boot
  • PostgreSQL 17
mkdir releaseflow && cd releaseflow
base=https://github.com/hoangluongtran0309/ReleaseFlow/releases/latest/download
curl -fsSL --remote-name-all "$base/compose.yaml" "$base/quickstart.sh" "$base/SHA256SUMS"
sha256sum --check --ignore-missing SHA256SUMS
bash quickstart.sh
Sau đó mở http://localhost:8080/register để tạo administrator đầu tiên.

Giữ lại file .env được tạo ra. File này chứa mật khẩu database và khóa dùng để mã hóa các credential đã lưu.

Trước khi bắt đầu

Máy chủ cần những gì​

Một máy do bạn kiểm soát, cùng vài công cụ tiêu chuẩn. Không phải biên dịch và không cần clone repository.

Docker Compose v2

Docker Engine hoặc Docker Desktop, với Compose đủ mới để chờ một service healthy. Nó chạy container của ứng dụng và PostgreSQL.

openssl

Tạo mật khẩu database và credential master key trong lần chạy đầu tiên.

curl và sha256sum

Tải các file của bản phát hành và kiểm tra chúng với SHA256SUMS. Trên macOS, dùng shasum -a 256.

Linux hoặc macOS

Trên Windows, chạy bên trong WSL 2. Image chỉ có bản amd64, nên Apple silicon chạy nó qua giả lập.

Mạng

Lần khởi động đầu tiên tải hai image. Sau đó nó chỉ gọi tới các source bạn kết nối và các provider bạn bật; các source gửi webhook phải truy cập được tới nó.

Bên trong

Quickstart làm những gì​

Năm bước: bạn tự chạy hai bước đầu, quickstart.sh làm phần còn lại. Đọc script trước khi chạy.

Đọc quickstart.sh(mở trong thẻ mới)
  1. Tải các file của bản phát hành

    compose.yaml, quickstart.sh và SHA256SUMS được lấy từ bản phát hành mới nhất trên GitHub.

  2. Kiểm tra trước khi chạy bất cứ thứ gì

    sha256sum đối chiếu các file đã tải với checksum đã công bố.

  3. Kiểm tra máy, rồi ghi .env

    Script xác nhận Docker, Compose v2 và một daemon truy cập được, và không cài đặt gì. Trong lần chạy đầu tiên, nó ghi mật khẩu database và credential master key mới vào .env, chỉ bạn đọc được.

  4. Khởi động hai container

    Ứng dụng ReleaseFlow và PostgreSQL, không có gì khác. Script chờ đến khi ứng dụng healthy.

  5. Mặc định là riêng tư

    Ứng dụng chỉ lắng nghe trên 127.0.0.1, và cổng database hoàn toàn không được publish.

Các lệnh trên chạy với bản release v1.0.0, trong 38 giây. Image đã có sẵn trên máy này; lần khởi động đầu tiên sẽ tải chúng nên lâu hơn.

Đưa vào production

Đặt proxy của bạn phía trước, giữ phần còn lại riêng tư.​

Quickstart dành cho một máy: nó chỉ lắng nghe trên loopback, còn TLS, backup và lưu trữ secret là phần một deployment thật phải tự lo. Để chia sẻ ReleaseFlow với đội ngũ, phục vụ nó qua HTTPS từ một reverse proxy bạn đang chạy, và đặt RELEASEFLOW_SESSION_COOKIE_SECURE=true cùng RELEASEFLOW_PUBLIC_BASE_URL theo địa chỉ công khai.

Đội ngũ của bạnTrình duyệt
Webhook từ sourceGitHub · GitLab · Linear
Hạ tầng của bạn
Reverse proxyTLS trên domain của bạn
ReleaseFlow127.0.0.1:8080 · Java 21
PostgreSQLKhông publish · credential đã mã hóa
Outbound, chỉ những gì bạn cấu hìnhSource API · AI · DeepL · Email · Delivery

Checklist production

Trước khi đội ngũ phụ thuộc vào nó​

Hướng dẫn vận hành

FAQ

Câu hỏi về tự triển khai​

Có bản hosted hoặc bản trả phí không?

Không. Mọi người đều chạy cùng mã nguồn Apache-2.0. Không có hosted control plane hay bản enterprise để phải phụ thuộc.

Tôi có cần AI provider không?

Không. Các quy tắc phân loại thay đổi mà không cần AI. AI, dịch thuật, email và các tích hợp delivery đều là tùy chọn, và mỗi thứ chỉ chạy khi bạn cấu hình.

Nó tạo những kết nối outbound nào?

Chỉ tới các source bạn kết nối và các provider bạn cấu hình. Bạn quyết định nó được phép kết nối tới những dịch vụ bên ngoài nào.

Token và webhook secret được lưu thế nào?

Được mã hóa trong PostgreSQL bằng master key bạn cung cấp. Chúng không bao giờ được đọc lại vào trang hay API response.

Tôi tìm trợ giúp ở đâu?

Hỏi trong GitHub Discussions, báo lỗi trong Issues, và gửi vấn đề bảo mật qua kênh báo cáo riêng tư.

Bị kẹt ở một bước?​

Tìm trong tài liệu, hoặc hỏi trong Discussions kèm phiên bản bạn dùng và những gì bạn đã chạy.