From 0b74e7bbe8c1bcb6a9c087ab1abc802ad93a0fe4 Mon Sep 17 00:00:00 2001 From: Sun-ZhenXing <1006925066@qq.com> Date: Wed, 24 Sep 2025 22:24:11 +0800 Subject: [PATCH] feat: add .env.example for all --- README.md | 30 +++++++++++++---- README.zh.md | 30 +++++++++++++---- src/bifrost-gateway/.env.example | 5 +++ src/docker-registry/.env.example | 17 ++++++++++ src/frpc/.env.example | 7 ++++ src/frps/.env.example | 15 +++++++++ src/gitea-runner/.env.example | 11 ++++++ src/gitea-runner/docker-compose.yaml | 11 ++++-- src/gitea/.env.example | 16 +++++++++ src/gitlab-runner/.env.example | 2 ++ src/gitlab-runner/.gitignore | 1 + src/gitlab-runner/docker-compose.yml | 31 ++++++++++++----- src/gitlab/.env.example | 7 ++++ src/gitlab/.gitignore | 1 + src/gitlab/docker-compose.yaml | 43 ++++++++++++++++-------- src/milvus-standalone-embed/.env.example | 12 +++++++ src/milvus-standalone/.env.example | 19 +++++++++++ src/mineru-sgalng/.env.example | 7 ++++ src/mineru-v2/.env.example | 7 ++++ src/minio/.env.example | 15 ++++++++- src/mongodb-replicaset/.env.example | 17 ++++++++++ src/mysql/.env.example | 11 ++++++ src/ollama/.env.example | 5 +++ src/open-webui/.env.example | 15 +++++++-- src/pocketbase/.env.example | 13 +++++-- src/postgres/.env.example | 15 ++++++++- src/qdrant/.env.example | 12 +++---- src/rabbitmq/.env.example | 10 ++++++ src/redis/.env.example | 2 +- 29 files changed, 336 insertions(+), 51 deletions(-) create mode 100644 src/gitlab-runner/.gitignore create mode 100644 src/gitlab/.gitignore diff --git a/README.md b/README.md index 5fbf906..7356624 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,30 @@ Compose Anything helps users quickly deploy various services by providing a set ## Supported Services -| Service | Version | -| ---------------------------------------- | ------- | -| [Redis](./src/redis) | 8.2.1 | -| [MinerU v2](./src/mineru-v2) | 2.5.3 | -| [Bifrost Gateway](./src/bifrost-gateway) | 1.2.15 | -| [Docker Registry](./src/docker-registry) | 3.0.0 | +| Service | Version | +| -------------------------------------------------------- | ---------------------------- | +| [Bifrost Gateway](./src/bifrost-gateway) | 1.2.15 | +| [Docker Registry](./src/docker-registry) | 3.0.0 | +| [frpc](./src/frpc) | 0.64.0 | +| [frps](./src/frps) | 0.64.0 | +| [Gitea](./src/gitea) | 1.24.6 | +| [Gitea Runner](./src/gitea-runner) | 0.2.12 | +| [GitLab](./src/gitlab) | 17.10.4-ce.0 | +| [GitLab Runner](./src/gitlab-runner) | 17.10.1 | +| [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 | +| [MySQL](./src/mysql) | 9.4.0 | +| [Ollama](./src/ollama) | 0.12.0 | +| [Open WebUI](./src/open-webui) | main | +| [PocketBase](./src/pocketbase) | 0.30.0 | +| [PostgreSQL](./src/postgres) | 17.6 | +| [Qdrant](./src/qdrant) | 1.15.4 | +| [RabbitMQ](./src/rabbitmq) | 4.1.4 | +| [Redis](./src/redis) | 8.2.1 | ## Guidelines diff --git a/README.zh.md b/README.zh.md index d9e460a..07bf52f 100644 --- a/README.zh.md +++ b/README.zh.md @@ -4,12 +4,30 @@ Compose Anything 通过提供一组高质量的 Docker Compose 配置文件, ## 已经支持的服务 -| 服务 | 版本 | -| ---------------------------------------- | ------ | -| [Redis](./src/redis) | 8.2.1 | -| [MinerU v2](./src/mineru-v2) | 2.5.3 | -| [Bifrost Gateway](./src/bifrost-gateway) | 1.2.15 | -| [Docker Registry](./src/docker-registry) | 3.0.0 | +| 服务 | 版本 | +| -------------------------------------------------------- | ---------------------------- | +| [Bifrost Gateway](./src/bifrost-gateway) | 1.2.15 | +| [Docker Registry](./src/docker-registry) | 3.0.0 | +| [frpc](./src/frpc) | 0.64.0 | +| [frps](./src/frps) | 0.64.0 | +| [Gitea](./src/gitea) | 1.24.6 | +| [Gitea Runner](./src/gitea-runner) | 0.2.12 | +| [GitLab](./src/gitlab) | 17.10.4-ce.0 | +| [GitLab Runner](./src/gitlab-runner) | 17.10.1 | +| [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 | +| [MySQL](./src/mysql) | 9.4.0 | +| [Ollama](./src/ollama) | 0.12.0 | +| [Open WebUI](./src/open-webui) | main | +| [PocketBase](./src/pocketbase) | 0.30.0 | +| [PostgreSQL](./src/postgres) | 17.6 | +| [Qdrant](./src/qdrant) | 1.15.4 | +| [RabbitMQ](./src/rabbitmq) | 4.1.4 | +| [Redis](./src/redis) | 8.2.1 | ## 规范 diff --git a/src/bifrost-gateway/.env.example b/src/bifrost-gateway/.env.example index e69de29..f0ff7d5 100644 --- a/src/bifrost-gateway/.env.example +++ b/src/bifrost-gateway/.env.example @@ -0,0 +1,5 @@ +# Bifrost Gateway Version +BIFROST_VERSION=v1.2.15 + +# Port to bind to on the host machine +BIFROST_PORT=28080 diff --git a/src/docker-registry/.env.example b/src/docker-registry/.env.example index e69de29..b3193af 100644 --- a/src/docker-registry/.env.example +++ b/src/docker-registry/.env.example @@ -0,0 +1,17 @@ +# Docker Registry Version +REGISTRY_VERSION=3.0.0 + +# Port to bind to on the host machine +REGISTRY_PORT=5000 + +# Authentication settings +REGISTRY_AUTH=htpasswd +REGISTRY_AUTH_HTPASSWD_REALM=Registry Realm +REGISTRY_AUTH_HTPASSWD_PATH=/certs/passwd + +# TLS settings (optional) +REGISTRY_HTTP_TLS_CERTIFICATE= +REGISTRY_HTTP_TLS_KEY= + +# OpenTelemetry settings +OTEL_TRACES_EXPORTER=none diff --git a/src/frpc/.env.example b/src/frpc/.env.example index e69de29..316343e 100644 --- a/src/frpc/.env.example +++ b/src/frpc/.env.example @@ -0,0 +1,7 @@ +# FRP Client Version +FRPC_VERSION=0.64.0 + +# FRP server configuration +FRP_SERVER_ADDR=your.server.com +FRP_SERVER_PORT=7000 +FRP_SERVER_TOKEN=your_token_here diff --git a/src/frps/.env.example b/src/frps/.env.example index e69de29..54883b5 100644 --- a/src/frps/.env.example +++ b/src/frps/.env.example @@ -0,0 +1,15 @@ +# FRP Server Version +FRPS_VERSION=0.64.0 + +# FRP server configuration +FRP_SERVER_TOKEN=your_token_here +FRP_SERVER_PORT=9870 +FRP_ADMIN_PORT=7890 + +# Admin credentials +FRP_ADMIN_USER=admin +FRP_ADMIN_PASS=password + +# Port overrides +FRP_PORT_OVERRIDE_SERVER=9870 +FRP_PORT_OVERRIDE_ADMIN=7890 diff --git a/src/gitea-runner/.env.example b/src/gitea-runner/.env.example index e69de29..e368fac 100644 --- a/src/gitea-runner/.env.example +++ b/src/gitea-runner/.env.example @@ -0,0 +1,11 @@ +# Gitea instance URL +INSTANCE_URL=http://localhost:3000 + +# Registration token (get from Gitea settings -> Actions -> Runners) +REGISTRATION_TOKEN= + +# Runner name +RUNNER_NAME=Gitea-Runner + +# Runner labels +RUNNER_LABELS=DockerRunner diff --git a/src/gitea-runner/docker-compose.yaml b/src/gitea-runner/docker-compose.yaml index 40e0647..dc419a2 100644 --- a/src/gitea-runner/docker-compose.yaml +++ b/src/gitea-runner/docker-compose.yaml @@ -24,9 +24,14 @@ services: - ./config.yaml:/config.yaml:ro - gitea_runner_data:/data - /var/run/docker.sock:/var/run/docker.sock - extra_hosts: - - host.docker.internal:host-gateway - + deploy: + resources: + limits: + cpus: '1.0' + memory: 2G + reservations: + cpus: '0.5' + memory: 1G volumes: gitea_runner_data: diff --git a/src/gitea/.env.example b/src/gitea/.env.example index e69de29..5d591b6 100644 --- a/src/gitea/.env.example +++ b/src/gitea/.env.example @@ -0,0 +1,16 @@ +# Gitea Version +GITEA_VERSION=1.24.6-rootless + +# Database configuration +GITEA_DB_TYPE=postgres +GITEA_POSTGRES_HOST=db:5432 + +# PostgreSQL settings +POSTGRES_VERSION=17.6 +POSTGRES_USER=gitea +POSTGRES_PASSWORD=gitea +POSTGRES_DB=gitea + +# Gitea ports +GITEA_HTTP_PORT=3000 +GITEA_SSH_PORT=3022 diff --git a/src/gitlab-runner/.env.example b/src/gitlab-runner/.env.example index e69de29..b869fb7 100644 --- a/src/gitlab-runner/.env.example +++ b/src/gitlab-runner/.env.example @@ -0,0 +1,2 @@ +# GitLab Runner Version +GITLAB_RUNNER_VERSION=alpine3.21-v18.4.0 diff --git a/src/gitlab-runner/.gitignore b/src/gitlab-runner/.gitignore new file mode 100644 index 0000000..50cf6de --- /dev/null +++ b/src/gitlab-runner/.gitignore @@ -0,0 +1 @@ +/config diff --git a/src/gitlab-runner/docker-compose.yml b/src/gitlab-runner/docker-compose.yml index e15f2f9..fb6cf8d 100644 --- a/src/gitlab-runner/docker-compose.yml +++ b/src/gitlab-runner/docker-compose.yml @@ -1,14 +1,27 @@ +x-default: &default + restart: unless-stopped + volumes: + - &localtime /etc/localtime:/etc/localtime:ro + - &timezone /etc/timezone:/etc/timezone:ro + logging: + driver: json-file + options: + max-size: 100m + services: gitlab-runner: - image: gitlab/gitlab-runner:alpine3.21-v17.10.1 - restart: unless-stopped + <<: *default + image: gitlab/gitlab-runner:${GITLAB_RUNNER_VERSION:-alpine3.21-v18.4.0} volumes: - - /etc/localtime:/etc/localtime:ro - - /etc/timezone:/etc/timezone:ro + - *localtime + - *timezone - /var/run/docker.sock:/var/run/docker.sock - ./config:/etc/gitlab-runner - network_mode: host -networks: - host: - name: host - external: true + deploy: + resources: + limits: + cpus: '1.0' + memory: 2G + reservations: + cpus: '0.5' + memory: 1G diff --git a/src/gitlab/.env.example b/src/gitlab/.env.example index e69de29..4ea3a3d 100644 --- a/src/gitlab/.env.example +++ b/src/gitlab/.env.example @@ -0,0 +1,7 @@ +# GitLab Version +GITLAB_VERSION=18.4.0-ce.0 + +# GitLab ports +GITLAB_PORT_OVERRIDE_HTTPS=5443 +GITLAB_PORT_OVERRIDE_HTTP=5080 +GITLAB_PORT_OVERRIDE_SSH=5022 diff --git a/src/gitlab/.gitignore b/src/gitlab/.gitignore new file mode 100644 index 0000000..50cf6de --- /dev/null +++ b/src/gitlab/.gitignore @@ -0,0 +1 @@ +/config diff --git a/src/gitlab/docker-compose.yaml b/src/gitlab/docker-compose.yaml index 7410cca..acea80b 100644 --- a/src/gitlab/docker-compose.yaml +++ b/src/gitlab/docker-compose.yaml @@ -1,21 +1,36 @@ +x-default: &default + restart: unless-stopped + volumes: + - &localtime /etc/localtime:/etc/localtime:ro + - &timezone /etc/timezone:/etc/timezone:ro + logging: + driver: json-file + options: + max-size: 100m + services: gitlab: - image: gitlab/gitlab-ce:17.10.4-ce.0 - container_name: gitlab - restart: unless-stopped + <<: *default + image: gitlab/gitlab-ce:${GITLAB_VERSION:-18.4.0-ce.0} ports: - - "5443:443" - - "5080:80" - - "5022:22" + - "${GITLAB_PORT_OVERRIDE_HTTPS:-5443}:443" + - "${GITLAB_PORT_OVERRIDE_HTTP:-5080}:80" + - "${GITLAB_PORT_OVERRIDE_SSH:-5022}:22" volumes: - - /etc/localtime:/etc/localtime:ro - - /etc/timezone:/etc/timezone:ro + - *localtime + - *timezone - ./config:/etc/gitlab - - logs:/var/log/gitlab - - data:/var/opt/gitlab - extra_hosts: - - host.docker.internal:host-gateway + - gitlab_logs:/var/log/gitlab + - gitlab_data:/var/opt/gitlab + deploy: + resources: + limits: + cpus: '2.0' + memory: 8G + reservations: + cpus: '1.0' + memory: 4G volumes: - logs: - data: + gitlab_logs: + gitlab_data: diff --git a/src/milvus-standalone-embed/.env.example b/src/milvus-standalone-embed/.env.example index e69de29..66f5a77 100644 --- a/src/milvus-standalone-embed/.env.example +++ b/src/milvus-standalone-embed/.env.example @@ -0,0 +1,12 @@ +# Component versions +MILVUS_VERSION=v2.6.2 +ATTU_VERSION=v2.6.0 + +# Milvus configuration +MILVUS_PORT_OVERRIDE_HTTP=19530 +MILVUS_PORT_OVERRIDE_WEBUI=9091 +MILVUS_PORT_OVERRIDE_ETCD=2379 +MILVUS_URL=milvus-standalone-embed:19530 + +# Attu (Management UI) configuration +ATTU_OVERRIDE_PORT=8000 diff --git a/src/milvus-standalone/.env.example b/src/milvus-standalone/.env.example index e69de29..a8ecc25 100644 --- a/src/milvus-standalone/.env.example +++ b/src/milvus-standalone/.env.example @@ -0,0 +1,19 @@ +# Component versions +ETCD_VERSION=v3.5.18 +MINIO_VERSION=RELEASE.2024-12-18T13-15-44Z +MILVUS_VERSION=v2.6.2 +ATTU_VERSION=v2.6.0 + +# MinIO configuration +MINIO_ACCESS_KEY=minioadmin +MINIO_SECRET_KEY=minioadmin +MINIO_PORT_OVERRIDE_API=9000 +MINIO_PORT_OVERRIDE_WEBUI=9001 + +# Milvus configuration +MILVUS_PORT_OVERRIDE_HTTP=19530 +MILVUS_PORT_OVERRIDE_WEBUI=9091 +MILVUS_URL=milvus-standalone:19530 + +# Attu (Management UI) configuration +ATTU_PORT_OVERRIDE=8000 diff --git a/src/mineru-sgalng/.env.example b/src/mineru-sgalng/.env.example index e69de29..c8b3748 100644 --- a/src/mineru-sgalng/.env.example +++ b/src/mineru-sgalng/.env.example @@ -0,0 +1,7 @@ +# MinerU SGLang Docker image +MINERU_DOCKER_IMAGE=alexsuntop/mineru-sglang:2.2.2 + +# Port configurations +MINERU_PORT_OVERRIDE_SGLANG=30000 +MINERU_PORT_OVERRIDE_API=8000 +MINERU_PORT_OVERRIDE_GRADIO=7860 diff --git a/src/mineru-v2/.env.example b/src/mineru-v2/.env.example index e69de29..4fc4085 100644 --- a/src/mineru-v2/.env.example +++ b/src/mineru-v2/.env.example @@ -0,0 +1,7 @@ +# MinerU Docker image +MINERU_DOCKER_IMAGE=alexsuntop/mineru:2.5.3 + +# Port configurations +MINERU_PORT_OVERRIDE_VLLM=30000 +MINERU_PORT_OVERRIDE_API=8000 +MINERU_PORT_OVERRIDE_GRADIO=7860 diff --git a/src/minio/.env.example b/src/minio/.env.example index 5fe4581..13f8582 100644 --- a/src/minio/.env.example +++ b/src/minio/.env.example @@ -1 +1,14 @@ -MINIO_ROOT_PASSWORD= +# MinIO Version +MINIO_VERSION=RELEASE.2025-09-07T16-13-09Z + +# MinIO credentials +MINIO_ROOT_USER=root +MINIO_ROOT_PASSWORD=password123 + +# Optional: Legacy access key/secret (use root user/password instead) +MINIO_ACCESS_KEY= +MINIO_SECRET_KEY= + +# Ports +MINIO_PORT_OVERRIDE_API=9000 +MINIO_PORT_OVERRIDE_WEBUI=9001 diff --git a/src/mongodb-replicaset/.env.example b/src/mongodb-replicaset/.env.example index e69de29..7aaf22a 100644 --- a/src/mongodb-replicaset/.env.example +++ b/src/mongodb-replicaset/.env.example @@ -0,0 +1,17 @@ +# MongoDB Version +MONGO_VERSION=8.0.13 + +# MongoDB root credentials +MONGO_INITDB_ROOT_USERNAME=root +MONGO_INITDB_ROOT_PASSWORD=password + +# Initial database name +MONGO_INITDB_DATABASE=admin + +# Replica set name +MONGO_REPLICA_SET_NAME=rs0 + +# MongoDB ports for each replica +MONGO_PORT_OVERRIDE_1=27017 +MONGO_PORT_OVERRIDE_2=27018 +MONGO_PORT_OVERRIDE_3=27019 diff --git a/src/mysql/.env.example b/src/mysql/.env.example index e69de29..6805052 100644 --- a/src/mysql/.env.example +++ b/src/mysql/.env.example @@ -0,0 +1,11 @@ +# MySQL Version +MYSQL_VERSION=9.4.0 + +# Root password for MySQL +MYSQL_ROOT_PASSWORD=password + +# Host pattern for root user access (% means all hosts) +MYSQL_ROOT_HOST=% + +# Port to bind to on the host machine +MYSQL_PORT_OVERRIDE=3306 diff --git a/src/ollama/.env.example b/src/ollama/.env.example index e69de29..804d3e9 100644 --- a/src/ollama/.env.example +++ b/src/ollama/.env.example @@ -0,0 +1,5 @@ +# Ollama Version +OLLAMA_VERSION=0.12.0 + +# Port to bind to on the host machine +OLLAMA_PORT_OVERRIDE=11434 diff --git a/src/open-webui/.env.example b/src/open-webui/.env.example index 1c66f94..4b73800 100644 --- a/src/open-webui/.env.example +++ b/src/open-webui/.env.example @@ -1,4 +1,15 @@ -OPENAI_API_BASE_URL= +# Open WebUI Version +OPEN_WEBUI_VERSION=main + +# Port to bind to on the host machine +OPEN_WEBUI_PORT=8080 + +# OpenAI API Configuration (optional) +OPENAI_API_BASE_URL=https://api.openai.com/v1 OPENAI_API_KEY= -ENABLE_OLLAMA_API= + +# Enable Ollama API integration (default: true) +ENABLE_OLLAMA_API=true + +# WebUI URL (optional, for external access configuration) WEBUI_URL= diff --git a/src/pocketbase/.env.example b/src/pocketbase/.env.example index 9a74ef0..c903ec2 100644 --- a/src/pocketbase/.env.example +++ b/src/pocketbase/.env.example @@ -1,3 +1,12 @@ +# PocketBase Version +PB_VERSION=0.30.0 + +# Port to bind to on the host machine +PB_PORT=8090 + +# Optional 32-character encryption key (generate with: openssl rand -hex 16) PB_ENCRYPTION= -PB_ADMIN_EMAIL= -PB_ADMIN_PASSWORD= + +# Admin user configuration +PB_ADMIN_EMAIL=admin@example.com +PB_ADMIN_PASSWORD=supersecret123 diff --git a/src/postgres/.env.example b/src/postgres/.env.example index c14aa52..6fdeb47 100644 --- a/src/postgres/.env.example +++ b/src/postgres/.env.example @@ -1 +1,14 @@ -POSTGRES_PASSWORD= +# PostgreSQL Version +POSTGRES_VERSION=17.6 + +# Database user +POSTGRES_USER=postgres + +# Database password +POSTGRES_PASSWORD=postgres + +# Database name +POSTGRES_DB=postgres + +# Port to bind to on the host machine +POSTGRES_PORT=5432 diff --git a/src/qdrant/.env.example b/src/qdrant/.env.example index bec0da0..f07ad41 100644 --- a/src/qdrant/.env.example +++ b/src/qdrant/.env.example @@ -1,14 +1,14 @@ # Qdrant Version -QDRANT_VERSION="v1.15.4" +QDRANT_VERSION=v1.15.4 -# Qdrant API Key +# Qdrant API Key (optional, leave empty to disable authentication) QDRANT_API_KEY= -# Use RBAC -QDRANT_JWT_RBAC=true +# Use RBAC (set to false for simple setup) +QDRANT_JWT_RBAC=false # HTTP Port -QDRANT_HTTP_PORT= +QDRANT_HTTP_PORT=6333 # gRPC Port -QDRANT_GRPC_PORT= +QDRANT_GRPC_PORT=6334 diff --git a/src/rabbitmq/.env.example b/src/rabbitmq/.env.example index e69de29..9db002a 100644 --- a/src/rabbitmq/.env.example +++ b/src/rabbitmq/.env.example @@ -0,0 +1,10 @@ +# RabbitMQ Version +RABBITMQ_VERSION=4.1.4-management-alpine + +# RabbitMQ credentials +RABBITMQ_DEFAULT_USER=admin +RABBITMQ_DEFAULT_PASS=password + +# Ports +RABBITMQ_PORT=5672 +RABBITMQ_MANAGEMENT_PORT=15672 diff --git a/src/redis/.env.example b/src/redis/.env.example index 2066e13..2663da3 100644 --- a/src/redis/.env.example +++ b/src/redis/.env.example @@ -8,4 +8,4 @@ SKIP_FIX_PERMS=1 REDIS_PASSWORD="passw0rd" # Port to bind to on the host machine -REDIS_PORT_OVERRIDE=16379 +REDIS_PORT_OVERRIDE=6379