Skip to content

Latest commit

 

History

History
82 lines (57 loc) · 2.44 KB

README.ZH-CN.md

File metadata and controls

82 lines (57 loc) · 2.44 KB

Crane - 快速且安全的 .tar.gz 部署工具

English | 简体中文

Crane 是一个使用 Rust 编写的简单、快速且安全的工具，用于下载和部署您的 .tar.gz 归档文件，无需服务器密码或密钥。

功能特点

  1. 快速: 使用 Rust 编写，Crane 提供仅 3MB 的轻量级二进制大小和仅 34MB 的 Docker 镜像，确保快速高效的部署。

  2. 简单: 只需一个 GET 请求，Crane 即可下载并解压您的 .tar.gz 文件，使部署过程变得轻松。

  3. 安全: Crane 无需服务器凭据或密钥即可运行，提供了额外的安全层。其 API 支持 API 密钥保护，并确保文件仅写入指定路径，防止未经授权的访问。

安装说明

Crane 会将 .tar.gz 文件解压到 /dist/ 目录下。所以在使用docker时，挂在你需要部署的host目录到容器的 /dist/ 目录下即可。

  1. 使用 Docker
docker run -e API_KEY={YOUR_SUPER_SECURE_API_KEY} -p 8594:8594 -v /dist_path_on_host/:/dist/ wangyucode/crane:0.1.2
  1. 使用 docker-compose
services:
  crane:
    image: wangyucode/crane:0.1.2
    environment:
      - API_KEY={YOUR_SUPER_SECURE_API_KEY}
    ports:
      - 8594:8594
    volumes:
      - /dist_path_on_host/:/dist/
  1. 从源码构建
git clone https://github.com/wangyucode/crane
cargo build --release
./target/release/crane

使用方法

curl -H "X-Api-Key: {YOUR_SUPER_SECURE_API_KEY}" http://{your_server_address}:8594/deploy?url=https://example.com/file.tar.gz

因此，您可以在 CI/CD 管道中使用它。

Github actions example:

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      ...
      - name: use Crane to deploy
        run: |
          curl -H "X-Api-Key: ${{secrets.CRANE_API_KEY}}" http://${secrets.SERVER_ADDRESS}:8594/deploy?url=https://github.com/your-repo/your-repo/releases/download/v1.0.0/dist.tar.gz
      ...

Waring: 警告: API_KEY 是必需的，如果未设置，Crane 将无法启动。请使用强密码。

路线图

  • 当新的部署被触发时，取消上一个部署
  • 支持选项，覆盖标志

其它选项

如果你正在寻找一个github actions, 来使用服务器密钥通过 sftp 部署文件，你可以尝试 wangyucode/sftp-upload-action