Chhoto URL 项目使用教程

Chhoto URL 项目使用教程

chhoto-url A simple, blazingly fast, selfhosted URL shortener with no unnecessary features; written in Rust. 项目地址: https://gitcode.com/gh_mirrors/ch/chhoto-url

1. 项目的目录结构及介绍

Chhoto URL 是一个简单、快速的自行托管 URL缩短服务，项目目录结构如下：

• .github/: 包含 GitHub 工作流程模板等文件。
• actix/: 后端代码，使用 Rust 编写的 Actix 框架。
• helm-chart/: Kubernetes 部署的 Helm 图表配置文件。
• resources/: 包含项目所需的资源文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• Dockerfile: Docker 镜像构建文件。
• Dockerfile.multiarch: 用于多架构构建的 Dockerfile。
• LICENSE: 项目许可证文件，本项目采用 MIT 许可。
• Makefile: 构建和部署项目的 Makefile 文件。
• README.md: 项目说明文件。
• compose.yaml: Docker Compose 配置文件。
• favicon.svgz: 网站图标文件。
• screenshot-desktop.webp 和 screenshot-mobile.webp: 项目屏幕截图。

2. 项目的启动文件介绍

项目主要通过 Docker 进行部署。以下是通过 docker-compose 启动项目的示例：

docker-compose up -d

如果您不使用 Docker Compose，可以手动构建和运行 Docker 镜像：

# 构建镜像
docker build . -t chhoto-url

# 运行镜像
docker run -p 4567:4567 -e password="password" -d chhoto-url:latest

在运行容器时，可以通过环境变量来设置密码、数据库路径等。

3. 项目的配置文件介绍

项目的配置主要通过环境变量进行，以下是一些重要的配置项：

• password: 设置管理员的密码。
• db_url: 设置数据库文件路径。
• site_url: 设置网站的 URL。
• api_key: 设置 API 密钥，用于激活 JSON 结果模式。
• redirect_method: 设置重定向方法，可以是 TEMPORARY 或 PERMANENT。
• slug_style: 设置短链接的风格，默认是形容词-名称对，可以设置为 UID 使用 UID。
• slug_length: 设置短链接的长度，默认为 8，最小支持 4。
• public_mode: 设置是否启用公共模式，允许任何人添加链接。
• disable_frontend: 设置是否禁用前端。
• cache_control_header: 设置自定义的缓存控制头部。

您可以通过修改 docker-compose.yaml 或在运行 Docker 容器时添加 -e 参数来设置这些环境变量。

以上就是 Chhoto URL 项目的目录结构、启动文件和配置文件的详细介绍。

chhoto-url A simple, blazingly fast, selfhosted URL shortener with no unnecessary features; written in Rust. 项目地址: https://gitcode.com/gh_mirrors/ch/chhoto-url