diff --git a/README.md b/README.md index 7356624..b953385 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ Compose Anything helps users quickly deploy various services by providing a set | Service | Version | | -------------------------------------------------------- | ---------------------------- | | [Bifrost Gateway](./src/bifrost-gateway) | 1.2.15 | +| [Clash](./src/clash) | 1.18.0 | | [Docker Registry](./src/docker-registry) | 3.0.0 | | [frpc](./src/frpc) | 0.64.0 | | [frps](./src/frps) | 0.64.0 | @@ -14,15 +15,18 @@ Compose Anything helps users quickly deploy various services by providing a set | [Gitea Runner](./src/gitea-runner) | 0.2.12 | | [GitLab](./src/gitlab) | 17.10.4-ce.0 | | [GitLab Runner](./src/gitlab-runner) | 17.10.1 | +| [IOPaint](./src/io-paint) | latest | | [Milvus Standalone](./src/milvus-standalone) | 2.6.2 | | [Milvus Standalone Embed](./src/milvus-standalone-embed) | 2.6.2 | | [MinerU SGALNG](./src/mineru-sgalng) | 2.2.2 | | [MinerU v2](./src/mineru-v2) | 2.5.3 | | [MinIO](./src/minio) | RELEASE.2025-09-07T16-13-09Z | | [MongoDB ReplicaSet](./src/mongodb-replicaset) | 8.0.13 | +| [MongoDB Standalone](./src/mongodb-standalone) | 8.0.13 | | [MySQL](./src/mysql) | 9.4.0 | | [Ollama](./src/ollama) | 0.12.0 | | [Open WebUI](./src/open-webui) | main | +| [OpenCut](./src/opencut) | latest | | [PocketBase](./src/pocketbase) | 0.30.0 | | [PostgreSQL](./src/postgres) | 17.6 | | [Qdrant](./src/qdrant) | 1.15.4 | diff --git a/README.zh.md b/README.zh.md index 07bf52f..a8cab32 100644 --- a/README.zh.md +++ b/README.zh.md @@ -7,6 +7,7 @@ Compose Anything 通过提供一组高质量的 Docker Compose 配置文件， | 服务 | 版本 | | -------------------------------------------------------- | ---------------------------- | | [Bifrost Gateway](./src/bifrost-gateway) | 1.2.15 | +| [Clash](./src/clash) | 1.18.0 | | [Docker Registry](./src/docker-registry) | 3.0.0 | | [frpc](./src/frpc) | 0.64.0 | | [frps](./src/frps) | 0.64.0 | @@ -14,15 +15,18 @@ Compose Anything 通过提供一组高质量的 Docker Compose 配置文件， | [Gitea Runner](./src/gitea-runner) | 0.2.12 | | [GitLab](./src/gitlab) | 17.10.4-ce.0 | | [GitLab Runner](./src/gitlab-runner) | 17.10.1 | +| [IOPaint](./src/io-paint) | latest | | [Milvus Standalone](./src/milvus-standalone) | 2.6.2 | | [Milvus Standalone Embed](./src/milvus-standalone-embed) | 2.6.2 | | [MinerU SGALNG](./src/mineru-sgalng) | 2.2.2 | | [MinerU v2](./src/mineru-v2) | 2.5.3 | | [MinIO](./src/minio) | RELEASE.2025-09-07T16-13-09Z | | [MongoDB ReplicaSet](./src/mongodb-replicaset) | 8.0.13 | +| [MongoDB Standalone](./src/mongodb-standalone) | 8.0.13 | | [MySQL](./src/mysql) | 9.4.0 | | [Ollama](./src/ollama) | 0.12.0 | | [Open WebUI](./src/open-webui) | main | +| [OpenCut](./src/opencut) | latest | | [PocketBase](./src/pocketbase) | 0.30.0 | | [PostgreSQL](./src/postgres) | 17.6 | | [Qdrant](./src/qdrant) | 1.15.4 | diff --git a/src/clash/.env.example b/src/clash/.env.example new file mode 100644 index 0000000..2ef52c8 --- /dev/null +++ b/src/clash/.env.example @@ -0,0 +1,2 @@ +# Clash 版本 +CLASH_VERSION=1.18.0 diff --git a/src/clash/README.md b/src/clash/README.md new file mode 100644 index 0000000..f613b1a --- /dev/null +++ b/src/clash/README.md @@ -0,0 +1,45 @@ +# Clash + +[English](./README.md) | [中文](./README.zh.md) + +Clash is a rule-based tunnel in Go. + +## Initialization + +1. Copy the example environment file: + + ```bash + cp .env.example .env + ``` + +2. Create your Clash configuration file `config.yaml` in the same directory. + +3. Start the service: + + ```bash + docker compose up -d + ``` + +## Services + +- `clash`: The Clash service. + +## Configuration + +- **Web Dashboard**: +- **SOCKS5 Proxy**: localhost:7890 +- **HTTP Proxy**: localhost:7890 + +| Variable | Description | Default | +| --------------- | ------------- | -------- | +| `CLASH_VERSION` | Clash version | `1.18.0` | + +## Security Notes + +- Change default passwords and configurations before production use +- Consider restricting access to the web dashboard +- Review your proxy rules and configurations + +## License + +Please refer to the official Clash project for license information. diff --git a/src/clash/README.zh.md b/src/clash/README.zh.md new file mode 100644 index 0000000..4ca6c02 --- /dev/null +++ b/src/clash/README.zh.md @@ -0,0 +1,45 @@ +# Clash + +[English](./README.md) | [中文](./README.zh.md) + +Clash 是一个用 Go 编写的基于规则的隧道工具。 + +## 初始化 + +1. 复制示例环境文件： + + ```bash + cp .env.example .env + ``` + +2. 在同一目录下创建你的 Clash 配置文件 `config.yaml`。 + +3. 启动服务： + + ```bash + docker compose up -d + ``` + +## 服务 + +- `clash`: Clash 服务。 + +## 配置 + +- **Web 仪表板**: +- **SOCKS5 代理**: localhost:7890 +- **HTTP 代理**: localhost:7890 + +| 变量 | 描述 | 默认值 | +| --------------- | ---------- | -------- | +| `CLASH_VERSION` | Clash 版本 | `1.18.0` | + +## 安全说明 + +- 在生产环境使用前更改默认密码和配置 +- 考虑限制对 Web 仪表板的访问 +- 检查你的代理规则和配置 + +## 许可证 + +请参考官方 Clash 项目的许可信息。 diff --git a/src/io-paint/.env.example b/src/io-paint/.env.example new file mode 100644 index 0000000..28ac3df --- /dev/null +++ b/src/io-paint/.env.example @@ -0,0 +1,8 @@ +# Docker Registry 镜像地址（可选） +DOCKER_REGISTRY=docker.io + +# 构建版本 +BUILD_VERSION=latest + +# Hugging Face 镜像端点（可选，用于中国大陆用户） +# HF_ENDPOINT=https://hf-mirror.com diff --git a/src/io-paint/README.md b/src/io-paint/README.md index 73d590b..548db0c 100644 --- a/src/io-paint/README.md +++ b/src/io-paint/README.md @@ -1,3 +1,60 @@ -# IOPaint +# IOPaint (Lama Cleaner) -Ref: [Dockerfile](https://github.com/Sanster/IOPaint/blob/main/docker/GPUDockerfile) +[English](./README.md) | [中文](./README.zh.md) + +IOPaint (formerly LaMa Cleaner) is a free and open-source inpainting & outpainting tool powered by SOTA AI model. + +## Prerequisites + +- NVIDIA GPU with CUDA support +- Docker with NVIDIA runtime support + +## Initialization + +1. Copy the example environment file: + + ```bash + cp .env.example .env + ``` + +2. Start the service: + + ```bash + docker compose up -d + ``` + +3. Access the web interface at + +## Services + +- `iopaint`: The IOPaint service. + +## Configuration + +The service runs on port 8080 and uses CUDA device 0 by default. + +| Variable | Description | Default | +| ----------------- | -------------------------------- | ----------- | +| `DOCKER_REGISTRY` | Docker registry to use | `docker.io` | +| `BUILD_VERSION` | Build version | `latest` | +| `HF_ENDPOINT` | Hugging Face endpoint (optional) | - | + +## Models + +Models are automatically downloaded and cached in the `./models` directory on first use. + +## GPU Support + +This configuration requires an NVIDIA GPU and uses CUDA device 0. Make sure you have: + +- NVIDIA drivers installed +- Docker with NVIDIA runtime support +- nvidia-docker2 package installed + +## Reference + +- [Dockerfile](https://github.com/Sanster/IOPaint/blob/main/docker/GPUDockerfile) + +## License + +Please refer to the official IOPaint project for license information. diff --git a/src/io-paint/README.zh.md b/src/io-paint/README.zh.md new file mode 100644 index 0000000..2afa577 --- /dev/null +++ b/src/io-paint/README.zh.md @@ -0,0 +1,54 @@ +# IOPaint (Lama Cleaner) + +[English](./README.md) | [中文](./README.zh.md) + +IOPaint（原 LaMa Cleaner）是一个由最先进的 AI 模型驱动的免费开源图像修复和扩展工具。 + +## 先决条件 + +- 支持 CUDA 的 NVIDIA GPU +- 支持 NVIDIA 运行时的 Docker + +## 初始化 + +1. 复制示例环境文件： + + ```bash + cp .env.example .env + ``` + +2. 启动服务： + + ```bash + docker compose up -d + ``` + +3. 在 访问 Web 界面 + +## 服务 + +- `iopaint`: IOPaint 服务。 + +## 配置 + +服务默认在端口 8080 运行，使用 CUDA 设备 0。 + +| 变量 | 描述 | 默认值 | +| ----------------- | ------------------------- | ----------- | +| `DOCKER_REGISTRY` | 使用的 Docker 镜像仓库 | `docker.io` | +| `BUILD_VERSION` | 构建版本 | `latest` | +| `HF_ENDPOINT` | Hugging Face 端点（可选） | - | + +## 模型 + +模型在首次使用时会自动下载并缓存在 `./models` 目录中。 + +## GPU 支持 + +此配置需要 NVIDIA GPU 并使用 CUDA 设备 0。确保你已安装： + +- NVIDIA 驱动程序 +- 支持 NVIDIA 运行时的 Docker +- nvidia-docker2 软件包 + +请参考官方 IOPaint 项目的许可信息。 diff --git a/src/mongodb-standalone/README.md b/src/mongodb-standalone/README.md new file mode 100644 index 0000000..5651af7 --- /dev/null +++ b/src/mongodb-standalone/README.md @@ -0,0 +1,62 @@ +# MongoDB Standalone + +[English](./README.md) | [中文](./README.zh.md) + +MongoDB is a document database designed for ease of application development and scaling. + +## Initialization + +1. Copy the example environment file: + + ```bash + cp .env.example .env + ``` + +2. Start the service: + + ```bash + docker compose up -d + ``` + +3. Connect to MongoDB at `mongodb://root:password@localhost:27017/admin` + +## Services + +- `mongo`: The MongoDB service. + +## Configuration + +- **Username**: `root` +- **Password**: `password` +- **Database**: `admin` +- **Port**: `27017` + +| Variable | Description | Default | +| ---------------------------- | ---------------- | ---------- | +| `MONGO_VERSION` | MongoDB version | `8.0.13` | +| `MONGO_INITDB_ROOT_USERNAME` | Root username | `root` | +| `MONGO_INITDB_ROOT_PASSWORD` | Root password | `password` | +| `MONGO_INITDB_DATABASE` | Initial database | `admin` | +| `MONGO_PORT_OVERRIDE` | Port override | `27017` | + +## Volumes + +- `mongo_data`: A volume for storing MongoDB data. + +```bash +# Using mongo shell +mongo mongodb://root:password@localhost:27017/admin + +# Using mongosh +mongosh "mongodb://root:password@localhost:27017/admin" +``` + +## Security Notes + +- Change the default password before production use +- Consider using MongoDB authentication and authorization features +- Restrict network access as needed + +## License + +MongoDB is available under the Server Side Public License (SSPL). diff --git a/src/mongodb-standalone/README.zh.md b/src/mongodb-standalone/README.zh.md new file mode 100644 index 0000000..6f140df --- /dev/null +++ b/src/mongodb-standalone/README.zh.md @@ -0,0 +1,62 @@ +# MongoDB 单机版 + +[English](./README.md) | [中文](./README.zh.md) + +MongoDB 是一个为应用程序开发和扩展的简易性而设计的文档数据库。 + +## 初始化 + +1. 复制示例环境文件： + + ```bash + cp .env.example .env + ``` + +2. 启动服务： + + ```bash + docker compose up -d + ``` + +3. 连接到 MongoDB：`mongodb://root:password@localhost:27017/admin` + +## 服务 + +- `mongo`: MongoDB 服务。 + +## 配置 + +- **用户名**: `root` +- **密码**: `password` +- **数据库**: `admin` +- **端口**: `27017` + +| 变量 | 描述 | 默认值 | +| ---------------------------- | ------------ | ---------- | +| `MONGO_VERSION` | MongoDB 版本 | `8.0.13` | +| `MONGO_INITDB_ROOT_USERNAME` | 根用户名 | `root` | +| `MONGO_INITDB_ROOT_PASSWORD` | 根密码 | `password` | +| `MONGO_INITDB_DATABASE` | 初始数据库 | `admin` | +| `MONGO_PORT_OVERRIDE` | 端口覆盖 | `27017` | + +## 卷 + +- `mongo_data`: 用于存储 MongoDB 数据的卷。 + +```bash +# 使用 mongo shell +mongo mongodb://root:password@localhost:27017/admin + +# 使用 mongosh +mongosh "mongodb://root:password@localhost:27017/admin" +``` + +## 安全说明 + +- 在生产环境使用前更改默认密码 +- 考虑使用 MongoDB 认证和授权功能 +- 根据需要限制网络访问 + +## 许可证 + +MongoDB 在服务器端公共许可证 (SSPL) 下可用。 diff --git a/src/opencut/.env.example b/src/opencut/.env.example new file mode 100644 index 0000000..5e31c4a --- /dev/null +++ b/src/opencut/.env.example @@ -0,0 +1,12 @@ +# FreeSound API 配置 +FREESOUND_CLIENT_ID=your_freesound_client_id +FREESOUND_API_KEY=your_freesound_api_key + +# Cloudflare R2 配置（可选，用于转录功能） +CLOUDFLARE_ACCOUNT_ID=your_cloudflare_account_id +R2_ACCESS_KEY_ID=your_r2_access_key_id +R2_SECRET_ACCESS_KEY=your_r2_secret_access_key +R2_BUCKET_NAME=your_r2_bucket_name + +# Modal 转录服务 URL（可选） +MODAL_TRANSCRIPTION_URL=your_modal_transcription_url diff --git a/src/opencut/README.md b/src/opencut/README.md index 1221f69..05fdceb 100644 --- a/src/opencut/README.md +++ b/src/opencut/README.md @@ -1,3 +1,74 @@ # OpenCut - +[English](./README.md) | [中文](./README.zh.md) + +OpenCut is an open-source video editing and audio processing platform. + +## Prerequisites + +1. Visit [FreeSound.org](https://freesound.org/) and create an account +2. Create an API application in your account settings +3. Get your client ID and API key + +## Initialization + +1. Copy the example environment file: + + ```bash + cp .env.example .env + ``` + +2. Configure the required environment variables (especially FreeSound API configuration) + +3. Start the service: + + ```bash + docker compose up -d + ``` + +4. Access the web interface at + +## Services + +- `opencut`: The OpenCut web application. +- `postgres`: The PostgreSQL database. +- `redis`: The Redis cache. + +## Configuration + +- **Web Application**: Port 3100 +- **PostgreSQL Database**: Port 5432 +- **Redis Cache**: Port 6379 +- **Redis HTTP Service**: Port 8079 + +| Variable | Description | Required | +| ------------------------- | ------------------------------- | -------- | +| `FREESOUND_CLIENT_ID` | FreeSound client ID | Yes | +| `FREESOUND_API_KEY` | FreeSound API key | Yes | +| `CLOUDFLARE_ACCOUNT_ID` | Cloudflare account ID | No* | +| `R2_ACCESS_KEY_ID` | R2 access key ID | No* | +| `R2_SECRET_ACCESS_KEY` | R2 secret key | No* | +| `R2_BUCKET_NAME` | R2 bucket name | No* | +| `MODAL_TRANSCRIPTION_URL` | Modal transcription service URL | No* | + +*Required for transcription features. Leave blank if auto-captioning is not needed. +4. Add these values to your `.env` file + +## Data Persistence + +- PostgreSQL data is stored in the `postgres_data` volume +- Redis data is in-memory and will be lost on restart + +## Security Notes + +- Change the default database password in production +- Update `BETTER_AUTH_SECRET` to a secure random string +- Consider setting up a reverse proxy for external access + +## Reference + +- [Original docker-compose.yaml](https://github.com/OpenCut-app/OpenCut/blob/main/docker-compose.yaml) + +## License + +Please refer to the official OpenCut project for license information. diff --git a/src/opencut/README.zh.md b/src/opencut/README.zh.md new file mode 100644 index 0000000..b5a6953 --- /dev/null +++ b/src/opencut/README.zh.md @@ -0,0 +1,69 @@ +# OpenCut + +[English](./README.md) | [中文](./README.zh.md) + +OpenCut 是一个开源的视频编辑和音频处理平台。 + +## 先决条件 + +1. 访问 [FreeSound.org](https://freesound.org/) 并创建账户 +2. 在账户设置中创建 API 应用 +3. 获取客户端 ID 和 API 密钥 + +## 初始化 + +1. 复制示例环境文件： + + ```bash + cp .env.example .env + ``` + +2. 配置必要的环境变量（特别是 FreeSound API 配置） + +3. 启动服务： + + ```bash + docker compose up -d + ``` + +4. 访问 Web 界面： + +## 服务 + +- `opencut`: OpenCut Web 应用。 +- `postgres`: PostgreSQL 数据库。 +- `redis`: Redis 缓存。 + +## 配置 + +- **Web 应用**: 端口 3100 +- **PostgreSQL 数据库**: 端口 5432 +- **Redis 缓存**: 端口 6379 +- **Redis HTTP 服务**: 端口 8079 + +| 变量 | 描述 | 必需 | +| ------------------------- | ------------------- | ---- | +| `FREESOUND_CLIENT_ID` | FreeSound 客户端 ID | 是 | +| `FREESOUND_API_KEY` | FreeSound API 密钥 | 是 | +| `CLOUDFLARE_ACCOUNT_ID` | Cloudflare 账户 ID | 否* | +| `R2_ACCESS_KEY_ID` | R2 访问密钥 ID | 否* | +| `R2_SECRET_ACCESS_KEY` | R2 密钥 | 否* | +| `R2_BUCKET_NAME` | R2 存储桶名称 | 否* | +| `MODAL_TRANSCRIPTION_URL` | Modal 转录服务 URL | 否* | + +*用于转录功能，如果不需要自动字幕功能可以留空。 + +## 数据持久化 + +- PostgreSQL 数据存储在 `postgres_data` 卷中 +- Redis 数据在内存中，重启后会丢失 + +## 安全说明 + +- 在生产环境中更改默认的数据库密码 +- 更新 `BETTER_AUTH_SECRET` 为一个安全的随机字符串 +- 考虑为外部访问设置反向代理 + +## 许可证 + +请参考官方 OpenCut 项目的许可信息。