Skip to content

Commit

Permalink
📝 docs: Docker-Compose english ver.
Browse files Browse the repository at this point in the history
  • Loading branch information
zhuozhiyongde committed Aug 27, 2024
1 parent 6cb8bcb commit 0e5b2b9
Show file tree
Hide file tree
Showing 5 changed files with 405 additions and 30 deletions.
31 changes: 16 additions & 15 deletions docker-compose/.env.example
Original file line number Diff line number Diff line change
@@ -1,34 +1,35 @@
# 网站域名
# LobeChat domain
APP_URL=https://lobe.example.com/

# Postgres 相关,也即 DB 必须的环境变量
# 用于加密敏感信息的密钥,可以使用 openssl rand -base64 32 生成
# Related to Postgres, which are the necessary environment variables for the DB
# Key used for encrypting sensitive information, can be generated using `openssl rand -base64 32`
KEY_VAULTS_SECRET=Kix2wcUONd4CX51E/ZPAd36BqM4wzJgKjPtz2sGztqQ=
# Postgres 数据库连接字符串
# 格式:postgres://username:password@host:port/dbname,如果你的 pg 实例为 Docker 容器,请使用容器名
# Postgres database connection string
# Format: postgres://username:password@host:port/dbname
# If your pg instance is a Docker container, please use the container name
DATABASE_URL=postgresql://postgres:uWNZugjBqixf8dxC@postgresql:5432/postgres

# NEXT_AUTH 相关,可以使用 auth0Azure ADGitHubAuthentikzitadel 等,如有其他接入诉求欢迎提 PR
# 这里以 GitHub 为例
# Related to NEXT_AUTH, can use auth0, Azure AD, GitHub, Authentik, zitadel, etc. If you have other integration requests, feel free to submit a PR
# Here is an example using GitHub
NEXT_AUTH_SECRET=cDdPtQevMi2uFFLUFNx9rJoposxo362G
NEXT_AUTH_SSO_PROVIDERS=github
NEXTAUTH_URL=https://lobe.example.com/api/auth
GITHUB_CLIENT_ID=h3nagLLGo4MxDGYB4SpU
GITHUB_CLIENT_SECRET=eL5poxnVPggh38Ny56HH6KbxnHehVymFyziET4jo
# 注:如果你有 ACCESS_CODE,请务必清空,我们以 NEXT_AUTH 作为唯一鉴权来源
# Proxy,如果你需要的话
# Note: If you have an ACCESS_CODE, please make sure to clear it, we use NEXT_AUTH as the only authentication source
# Proxy, if you need it
HTTP_PROXY=http://localhost:7890
HTTPS_PROXY=http://localhost:7890

# MinIO S3 配置
S3_ACCESS_KEY_ID=YOUR_S3_ACCESS_KEY_ID # 直到在 MinIO UI 中手动创建之前都是无效的
S3_SECRET_ACCESS_KEY=YOUR_S3_SECRET_ACCESS_KEY # 直到在 MinIO UI 中手动创建之前都是无效的
# MinIO S3 configuration
S3_ACCESS_KEY_ID=YOUR_S3_ACCESS_KEY_ID # Invalid until manually created in MinIO UI
S3_SECRET_ACCESS_KEY=YOUR_S3_SECRET_ACCESS_KEY # Invalid until manually created in MinIO UI
S3_ENDPOINT=https://lobe-s3-api.example.com
S3_BUCKET=lobe # 直到在 MinIO UI 中手动创建之前都是无效的
S3_BUCKET=lobe # Invalid until manually created in MinIO UI
S3_PUBLIC_DOMAIN=https://lobe-s3-api.example.com
S3_ENABLE_PATH_STYLE=1

# 其他环境变量,视需求而定,可以参照客户端版本的环境变量配置,注意不要有 ACCESS_CODE
# Other environment variables, depending on needs, can refer to the environment variable configuration of the client version, be careful not to have ACCESS_CODE
# OPEANAI_API_KEY=sk-xxxx
# OPENAI_PROXY_URL=https://api.openai.com/v1
# OPENAI_MODEL_LIST=...
# OPENAI_MODEL_LIST=...
35 changes: 35 additions & 0 deletions docker-compose/.env.zh-CN.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# LobeChat 域名
APP_URL=https://lobe.example.com/

# Postgres 相关,也即 DB 必须的环境变量
# 用于加密敏感信息的密钥,可以使用 `openssl rand -base64 32` 生成
KEY_VAULTS_SECRET=Kix2wcUONd4CX51E/ZPAd36BqM4wzJgKjPtz2sGztqQ=
# Postgres 数据库连接字符串
# 格式:postgres://username:password@host:port/dbname
# 如果你的 pg 实例为 Docker 容器,请使用容器名
DATABASE_URL=postgresql://postgres:uWNZugjBqixf8dxC@postgresql:5432/postgres

# NEXT_AUTH 相关,可以使用 auth0、Azure AD、GitHub、Authentik、zitadel 等,如有其他接入诉求欢迎提 PR
# 这里以 GitHub 为例
NEXT_AUTH_SECRET=cDdPtQevMi2uFFLUFNx9rJoposxo362G
NEXT_AUTH_SSO_PROVIDERS=github
NEXTAUTH_URL=https://lobe.example.com/api/auth
GITHUB_CLIENT_ID=h3nagLLGo4MxDGYB4SpU
GITHUB_CLIENT_SECRET=eL5poxnVPggh38Ny56HH6KbxnHehVymFyziET4jo
# 注:如果你有 ACCESS_CODE,请务必清空,我们以 NEXT_AUTH 作为唯一鉴权来源
# Proxy,如果你需要的话
HTTP_PROXY=http://localhost:7890
HTTPS_PROXY=http://localhost:7890

# MinIO S3 配置
S3_ACCESS_KEY_ID=YOUR_S3_ACCESS_KEY_ID # 直到在 MinIO UI 中手动创建之前都是无效的
S3_SECRET_ACCESS_KEY=YOUR_S3_SECRET_ACCESS_KEY # 直到在 MinIO UI 中手动创建之前都是无效的
S3_ENDPOINT=https://lobe-s3-api.example.com
S3_BUCKET=lobe # 直到在 MinIO UI 中手动创建之前都是无效的
S3_PUBLIC_DOMAIN=https://lobe-s3-api.example.com
S3_ENABLE_PATH_STYLE=1

# 其他环境变量,视需求而定,可以参照客户端版本的环境变量配置,注意不要有 ACCESS_CODE
# OPEANAI_API_KEY=sk-xxxx
# OPENAI_PROXY_URL=https://api.openai.com/v1
# OPENAI_MODEL_LIST=...
2 changes: 1 addition & 1 deletion docker-compose/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ services:
- 'MINIO_ROOT_USER=YOUR_MINIO_USER'
- 'MINIO_ROOT_PASSWORD=YOUR_MINIO_PASSWORD'
- 'MINIO_DOMAIN=lobe-s3-api.example.com'
- 'MINIO_API_CORS_ALLOW_ORIGIN=https://lobe.example.com' # 请注意这里的域名是你的 LobeChat 服务端域名
- 'MINIO_API_CORS_ALLOW_ORIGIN=https://lobe.example.com' # Your LobeChat's domain name.
restart: always
command: >
server /etc/minio/data --address ":9000" --console-address ":9001"
Expand Down
Loading

0 comments on commit 0e5b2b9

Please sign in to comment.