mirror of
https://github.com/lobehub/lobehub
synced 2026-04-21 17:47:27 +00:00
📝 docs: Docker compose for local. (#3651)
This commit is contained in:
Arthals
GitHub
parent
6e202a6831
commit
cef1733976
8 changed files with 414 additions and 29 deletions
35
docker-compose/local/.env.example
Normal file
35
docker-compose/local/.env.example
Normal file
|
|
@ -0,0 +1,35 @@
|
|||
# LobeChat domain
|
||||
APP_URL=https://localhost:3210
|
||||
|
||||
# Postgres related, which are the necessary environment variables for DB
|
||||
# Key used to encrypt sensitive information; can be generated using openssl rand -base64 32
|
||||
KEY_VAULTS_SECRET=Kix2wcUONd4CX51E/ZPAd36BqM4wzJgKjPtz2sGztqQ=
|
||||
# Postgres database connection string
|
||||
# Format: postgres://username:password@host:port/dbname; if your pg instance is a Docker container, use the container name
|
||||
DATABASE_URL=postgresql://postgres:uWNZugjBqixf8dxC@postgresql:5432/postgres
|
||||
|
||||
# NEXT_AUTH related; can use auth0, Azure AD, GitHub, Authentik, Zitadel, Logto, etc. If you have other integration requests, feel free to submit a PR.
|
||||
# Here we take Logto as an example
|
||||
NEXT_AUTH_SECRET=NX2kaPE923dt6BL2U8e9oSre5RfoT7hg
|
||||
NEXT_AUTH_SSO_PROVIDERS=logto
|
||||
NEXTAUTH_URL=http://localhost:3210/api/auth
|
||||
LOGTO_CLIENT_ID=YOUR_LOGTO_CLIENT_ID
|
||||
LOGTO_CLIENT_SECRET=YOUR_LOGTO_CLIENT_SECRET
|
||||
LOGTO_ISSUER=http://localhost:3001/oidc
|
||||
# Note: If you have ACCESS_CODE, be sure to clear it. We use NEXT_AUTH as the only authentication source.
|
||||
# Proxy, if you need it (e.g., if you use GitHub as an authentication service provider)
|
||||
# HTTP_PROXY=http://localhost:7890
|
||||
# HTTPS_PROXY=http://localhost:7890
|
||||
|
||||
# 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=http://localhost:9000
|
||||
S3_BUCKET=lobe # Invalid until manually created in MinIO UI
|
||||
S3_ENDPOINT=http://localhost:9000
|
||||
S3_ENABLE_PATH_STYLE=1
|
||||
|
||||
# Other environment variables, as needed. You can refer to the environment variables configuration for the client version, making sure not to have ACCESS_CODE.
|
||||
# OPEANAI_API_KEY=sk-xxxx
|
||||
# OPENAI_PROXY_URL=https://api.openai.com/v1
|
||||
# OPENAI_MODEL_LIST=...
|
||||
35
docker-compose/local/.env.zh-CN.example
Normal file
35
docker-compose/local/.env.zh-CN.example
Normal file
|
|
@ -0,0 +1,35 @@
|
|||
# LobeChat 域名
|
||||
APP_URL=https://localhost:3210
|
||||
|
||||
# Postgres 相关，也即 DB 必须的环境变量
|
||||
# 用于加密敏感信息的密钥，可以使用 openssl rand -base64 32 生成
|
||||
KEY_VAULTS_SECRET=Kix2wcUONd4CX51E/ZPAd36BqM4wzJgKjPtz2sGztqQ=
|
||||
# Postgres 数据库连接字符串
|
||||
# 格式：postgres://username:password@host:port/dbname，如果你的 pg 实例与 LobeChat 服务在同一 Docker 网络中，可以使用容器名作为 host
|
||||
DATABASE_URL=postgresql://postgres:uWNZugjBqixf8dxC@localhost:5432/postgres
|
||||
|
||||
# NEXT_AUTH 相关，可以使用 auth0、Azure AD、GitHub、Authentik、Zitadel、Logto 等，如有其他接入诉求欢迎提 PR
|
||||
# 这里以 Logto 为例
|
||||
NEXT_AUTH_SECRET=NX2kaPE923dt6BL2U8e9oSre5RfoT7hg
|
||||
NEXT_AUTH_SSO_PROVIDERS=logto
|
||||
NEXTAUTH_URL=http://localhost:3210/api/auth
|
||||
LOGTO_CLIENT_ID=YOUR_LOGTO_CLIENT_ID
|
||||
LOGTO_CLIENT_SECRET=YOUR_LOGTO_CLIENT_SECRET
|
||||
LOGTO_ISSUER=http://localhost:3001/oidc
|
||||
# 注：如果你有 ACCESS_CODE，请务必清空，我们以 NEXT_AUTH 作为唯一鉴权来源
|
||||
# Proxy，如果你需要的话（比如你使用 GitHub 作为鉴权服务提供商）
|
||||
# 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=http://localhost:9000
|
||||
S3_BUCKET=lobe # 直到在 MinIO UI 中手动创建之前都是无效的
|
||||
S3_PUBLIC_DOMAIN=http://localhost:9000
|
||||
S3_ENABLE_PATH_STYLE=1
|
||||
|
||||
# 其他环境变量，视需求而定，可以参照客户端版本的环境变量配置，注意不要有 ACCESS_CODE
|
||||
# OPEANAI_API_KEY=sk-xxxx
|
||||
# OPENAI_PROXY_URL=https://api.openai.com/v1
|
||||
# OPENAI_MODEL_LIST=...
|
||||
64
docker-compose/local/docker-compose.yml
Normal file
64
docker-compose/local/docker-compose.yml
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
services:
|
||||
postgresql:
|
||||
image: pgvector/pgvector:pg16
|
||||
container_name: lobe-postgres
|
||||
network_mode: 'host'
|
||||
volumes:
|
||||
- './data:/var/lib/postgresql/data'
|
||||
environment:
|
||||
- 'POSTGRES_DB=lobe'
|
||||
- 'POSTGRES_PASSWORD=uWNZugjBqixf8dxC'
|
||||
healthcheck:
|
||||
test: ['CMD-SHELL', 'pg_isready -U postgres']
|
||||
interval: 5s
|
||||
timeout: 5s
|
||||
retries: 5
|
||||
restart: always
|
||||
|
||||
minio:
|
||||
image: minio/minio
|
||||
container_name: lobe-minio
|
||||
network_mode: 'host'
|
||||
volumes:
|
||||
- './s3_data:/etc/minio/data'
|
||||
environment:
|
||||
- 'MINIO_ROOT_USER=YOUR_MINIO_USER'
|
||||
- 'MINIO_ROOT_PASSWORD=YOUR_MINIO_PASSWORD'
|
||||
- 'MINIO_DOMAIN=localhost:9000'
|
||||
- 'MINIO_API_CORS_ALLOW_ORIGIN=http://localhost:3210'
|
||||
restart: always
|
||||
command: >
|
||||
server /etc/minio/data --address ":9000" --console-address ":9001"
|
||||
|
||||
|
||||
logto:
|
||||
image: svhd/logto
|
||||
container_name: lobe-logto
|
||||
network_mode: 'host'
|
||||
depends_on:
|
||||
postgresql:
|
||||
condition: service_healthy
|
||||
environment:
|
||||
- 'TRUST_PROXY_HEADER=1'
|
||||
- 'DB_URL=postgresql://postgres:uWNZugjBqixf8dxC@localhost:5432/logto'
|
||||
- 'ENDPOINT=http://localhost:3001'
|
||||
- 'ADMIN_ENDPOINT=http://localhost:3002'
|
||||
entrypoint: ['sh', '-c', 'npm run cli db seed -- --swe && npm start']
|
||||
|
||||
lobe:
|
||||
image: lobehub/lobe-chat-database
|
||||
container_name: lobe-database
|
||||
network_mode: 'host'
|
||||
depends_on:
|
||||
- postgresql
|
||||
- minio
|
||||
- logto
|
||||
env_file:
|
||||
- .env
|
||||
restart: always
|
||||
|
||||
volumes:
|
||||
data:
|
||||
driver: local
|
||||
s3_data:
|
||||
driver: local
|
||||
|
|
@ -13,13 +13,13 @@ DATABASE_URL=postgresql://postgres:uWNZugjBqixf8dxC@postgresql:5432/postgres
|
|||
NEXT_AUTH_SECRET=NX2kaPE923dt6BL2U8e9oSre5RfoT7hg
|
||||
NEXT_AUTH_SSO_PROVIDERS=logto
|
||||
NEXTAUTH_URL=https://lobe.example.com/api/auth
|
||||
LOGTO_CLIENT_ID=buc2lpttyo6evdtrfqsur
|
||||
LOGTO_CLIENT_SECRET=d97eztx8Ej6aUafeToMAL4jugAKGTAH4
|
||||
LOGTO_CLIENT_ID=YOUR_LOGTO_CLIENT_ID
|
||||
LOGTO_CLIENT_SECRET=YOUR_LOGTO_CLIENT_SECRET
|
||||
LOGTO_ISSUER=https://lobe-auth-api.example.com/oidc
|
||||
# Note: If you have ACCESS_CODE, be sure to clear it. We use NEXT_AUTH as the only authentication source.
|
||||
# Proxy, if you need it (e.g., if you use GitHub as an authentication service provider)
|
||||
HTTP_PROXY=http://localhost:7890
|
||||
HTTPS_PROXY=http://localhost:7890
|
||||
# HTTP_PROXY=http://localhost:7890
|
||||
# HTTPS_PROXY=http://localhost:7890
|
||||
|
||||
# MinIO S3 configuration
|
||||
S3_ACCESS_KEY_ID=YOUR_S3_ACCESS_KEY_ID # Invalid until manually created in MinIO UI
|
||||
|
|
@ -13,13 +13,13 @@ DATABASE_URL=postgresql://postgres:uWNZugjBqixf8dxC@postgresql:5432/postgres
|
|||
NEXT_AUTH_SECRET=NX2kaPE923dt6BL2U8e9oSre5RfoT7hg
|
||||
NEXT_AUTH_SSO_PROVIDERS=logto
|
||||
NEXTAUTH_URL=https://lobe.example.com/api/auth
|
||||
LOGTO_CLIENT_ID=buc2lpttyo6evdtrfqsur
|
||||
LOGTO_CLIENT_SECRET=d97eztx8Ej6aUafeToMAL4jugAKGTAH4
|
||||
LOGTO_CLIENT_ID=YOUR_LOGTO_CLIENT_ID
|
||||
LOGTO_CLIENT_SECRET=YOUR_LOGTO_CLIENT_SECRET
|
||||
LOGTO_ISSUER=https://lobe-auth-api.example.com/oidc
|
||||
# 注：如果你有 ACCESS_CODE，请务必清空，我们以 NEXT_AUTH 作为唯一鉴权来源
|
||||
# Proxy，如果你需要的话（比如你使用 GitHub 作为鉴权服务提供商）
|
||||
HTTP_PROXY=http://localhost:7890
|
||||
HTTPS_PROXY=http://localhost:7890
|
||||
# HTTP_PROXY=http://localhost:7890
|
||||
# HTTPS_PROXY=http://localhost:7890
|
||||
|
||||
# MinIO S3 配置
|
||||
S3_ACCESS_KEY_ID=YOUR_S3_ACCESS_KEY_ID # 直到在 MinIO UI 中手动创建之前都是无效的
|
||||
|
|
@ -32,4 +32,4 @@ S3_ENABLE_PATH_STYLE=1
|
|||
# 其他环境变量，视需求而定，可以参照客户端版本的环境变量配置，注意不要有 ACCESS_CODE
|
||||
# OPEANAI_API_KEY=sk-xxxx
|
||||
# OPENAI_PROXY_URL=https://api.openai.com/v1
|
||||
# OPENAI_MODEL_LIST=...
|
||||
# OPENAI_MODEL_LIST=...
|
||||
|
|
@ -49,14 +49,20 @@ The following assumes that you choose to build all four required services for Lo
|
|||
### Create Configuration Files
|
||||
|
||||
```sh
|
||||
curl -fsSL https://raw.githubusercontent.com/lobehub/lobe-chat/HEAD/docker-compose/docker-compose.yml
|
||||
curl -fsSL https://raw.githubusercontent.com/lobehub/lobe-chat/HEAD/docker-compose/.env.example > .env
|
||||
curl -fsSL https://raw.githubusercontent.com/lobehub/lobe-chat/HEAD/docker-compose/local/docker-compose.yml
|
||||
curl -fsSL https://raw.githubusercontent.com/lobehub/lobe-chat/HEAD/docker-compose/local/.env.example > .env
|
||||
```
|
||||
|
||||
You can also copy these two example configuration files from the appendix below.
|
||||
|
||||
Please modify your `.env` and `docker-compose.yml` files according to the comments.
|
||||
|
||||
<Callout type="warning">
|
||||
|
||||
Due to network reasons, when starting locally, we intentionally let all services use `network_mode: host` simultaneously. This can solve some network issues, but it may cause port conflicts, please resolve them yourself.
|
||||
|
||||
</Callout>
|
||||
|
||||
### Start Services
|
||||
|
||||
```sh
|
||||
|
|
@ -196,6 +202,11 @@ If you need to configure SSL certificates, please configure them uniformly in th
|
|||
|
||||
### Configuration Files
|
||||
|
||||
```sh
|
||||
curl -fsSL https://raw.githubusercontent.com/lobehub/lobe-chat/HEAD/docker-compose/production/docker-compose.yml
|
||||
curl -fsSL https://raw.githubusercontent.com/lobehub/lobe-chat/HEAD/docker-compose/production/.env.example > .env
|
||||
```
|
||||
|
||||
The configuration files include `.env` and `docker-compose.yml`, where the `.env` file is used to configure LobeChat's environment variables, and the `docker-compose.yml` file is used to configure the Postgres, MinIO, and Logto services.
|
||||
|
||||
In general, you should only modify sensitive information such as domain names and account passwords, while other configuration items should be set according to the default values.
|
||||
|
|
@ -347,7 +358,121 @@ You have successfully deployed the LobeChat database version, and you can access
|
|||
|
||||
To facilitate one-click copying, here are the example configuration files needed to configure the server database:
|
||||
|
||||
### `.env`
|
||||
### Local Deployment
|
||||
|
||||
#### `.env`
|
||||
|
||||
```sh
|
||||
# LobeChat domain
|
||||
APP_URL=https://localhost:3210
|
||||
|
||||
# Postgres related, which are the necessary environment variables for DB
|
||||
# Key used to encrypt sensitive information; can be generated using openssl rand -base64 32
|
||||
KEY_VAULTS_SECRET=Kix2wcUONd4CX51E/ZPAd36BqM4wzJgKjPtz2sGztqQ=
|
||||
# Postgres database connection string
|
||||
# Format: postgres://username:password@host:port/dbname; if your pg instance is a Docker container, use the container name
|
||||
DATABASE_URL=postgresql://postgres:uWNZugjBqixf8dxC@postgresql:5432/postgres
|
||||
|
||||
# NEXT_AUTH related; can use auth0, Azure AD, GitHub, Authentik, Zitadel, Logto, etc. If you have other integration requests, feel free to submit a PR.
|
||||
# Here we take Logto as an example
|
||||
NEXT_AUTH_SECRET=NX2kaPE923dt6BL2U8e9oSre5RfoT7hg
|
||||
NEXT_AUTH_SSO_PROVIDERS=logto
|
||||
NEXTAUTH_URL=http://localhost:3210/api/auth
|
||||
LOGTO_CLIENT_ID=YOUR_LOGTO_CLIENT_ID
|
||||
LOGTO_CLIENT_SECRET=YOUR_LOGTO_CLIENT_SECRET
|
||||
LOGTO_ISSUER=http://localhost:3001/oidc
|
||||
# Note: If you have ACCESS_CODE, be sure to clear it. We use NEXT_AUTH as the only authentication source.
|
||||
# Proxy, if you need it (e.g., if you use GitHub as an authentication service provider)
|
||||
# HTTP_PROXY=http://localhost:7890
|
||||
# HTTPS_PROXY=http://localhost:7890
|
||||
|
||||
# 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=http://localhost:9000
|
||||
S3_BUCKET=lobe # Invalid until manually created in MinIO UI
|
||||
S3_ENDPOINT=http://localhost:9000
|
||||
S3_ENABLE_PATH_STYLE=1
|
||||
|
||||
# Other environment variables, as needed. You can refer to the environment variables configuration for the client version, making sure not to have ACCESS_CODE.
|
||||
# OPEANAI_API_KEY=sk-xxxx
|
||||
# OPENAI_PROXY_URL=https://api.openai.com/v1
|
||||
# OPENAI_MODEL_LIST=...
|
||||
|
||||
```
|
||||
|
||||
#### `docker-compose.yml`
|
||||
|
||||
```yaml
|
||||
services:
|
||||
postgresql:
|
||||
image: pgvector/pgvector:pg16
|
||||
container_name: lobe-postgres
|
||||
network_mode: 'host'
|
||||
volumes:
|
||||
- './data:/var/lib/postgresql/data'
|
||||
environment:
|
||||
- 'POSTGRES_DB=lobe'
|
||||
- 'POSTGRES_PASSWORD=uWNZugjBqixf8dxC'
|
||||
healthcheck:
|
||||
test: ['CMD-SHELL', 'pg_isready -U postgres']
|
||||
interval: 5s
|
||||
timeout: 5s
|
||||
retries: 5
|
||||
restart: always
|
||||
|
||||
minio:
|
||||
image: minio/minio
|
||||
container_name: lobe-minio
|
||||
network_mode: 'host'
|
||||
volumes:
|
||||
- './s3_data:/etc/minio/data'
|
||||
environment:
|
||||
- 'MINIO_ROOT_USER=YOUR_MINIO_USER'
|
||||
- 'MINIO_ROOT_PASSWORD=YOUR_MINIO_PASSWORD'
|
||||
- 'MINIO_DOMAIN=localhost:9000'
|
||||
- 'MINIO_API_CORS_ALLOW_ORIGIN=http://localhost:3210'
|
||||
restart: always
|
||||
command: >
|
||||
server /etc/minio/data --address ":9000" --console-address ":9001"
|
||||
|
||||
logto:
|
||||
image: svhd/logto
|
||||
container_name: lobe-logto
|
||||
network_mode: 'host'
|
||||
depends_on:
|
||||
postgresql:
|
||||
condition: service_healthy
|
||||
environment:
|
||||
- 'TRUST_PROXY_HEADER=1'
|
||||
- 'DB_URL=postgresql://postgres:uWNZugjBqixf8dxC@localhost:5432/logto'
|
||||
- 'ENDPOINT=http://localhost:3001'
|
||||
- 'ADMIN_ENDPOINT=http://localhost:3002'
|
||||
entrypoint: ['sh', '-c', 'npm run cli db seed -- --swe && npm start']
|
||||
|
||||
lobe:
|
||||
image: lobehub/lobe-chat-database
|
||||
container_name: lobe-database
|
||||
network_mode: 'host'
|
||||
depends_on:
|
||||
- postgresql
|
||||
- minio
|
||||
- logto
|
||||
env_file:
|
||||
- .env
|
||||
restart: always
|
||||
|
||||
volumes:
|
||||
data:
|
||||
driver: local
|
||||
s3_data:
|
||||
driver: local
|
||||
|
||||
```
|
||||
|
||||
### Deploying to Production
|
||||
|
||||
#### `.env`
|
||||
|
||||
```sh
|
||||
# LobeChat domain
|
||||
|
|
@ -365,13 +490,13 @@ DATABASE_URL=postgresql://postgres:uWNZugjBqixf8dxC@postgresql:5432/postgres
|
|||
NEXT_AUTH_SECRET=NX2kaPE923dt6BL2U8e9oSre5RfoT7hg
|
||||
NEXT_AUTH_SSO_PROVIDERS=logto
|
||||
NEXTAUTH_URL=https://lobe.example.com/api/auth
|
||||
LOGTO_CLIENT_ID=buc2lpttyo6evdtrfqsur
|
||||
LOGTO_CLIENT_SECRET=d97eztx8Ej6aUafeToMAL4jugAKGTAH4
|
||||
LOGTO_CLIENT_ID=YOUR_LOGTO_CLIENT_ID
|
||||
LOGTO_CLIENT_SECRET=YOUR_LOGTO_CLIENT_SECRET
|
||||
LOGTO_ISSUER=https://lobe-auth-api.example.com/oidc
|
||||
# Note: If you have ACCESS_CODE, be sure to clear it. We use NEXT_AUTH as the only authentication source.
|
||||
# Proxy, if you need it (e.g., if you use GitHub as an authentication service provider)
|
||||
HTTP_PROXY=http://localhost:7890
|
||||
HTTPS_PROXY=http://localhost:7890
|
||||
# HTTP_PROXY=http://localhost:7890
|
||||
# HTTPS_PROXY=http://localhost:7890
|
||||
|
||||
# MinIO S3 configuration
|
||||
S3_ACCESS_KEY_ID=YOUR_S3_ACCESS_KEY_ID # Invalid until manually created in MinIO UI
|
||||
|
|
@ -387,7 +512,7 @@ S3_ENABLE_PATH_STYLE=1
|
|||
# OPENAI_MODEL_LIST=...
|
||||
```
|
||||
|
||||
### `docker-compose.yml`
|
||||
#### `docker-compose.yml`
|
||||
|
||||
```yaml
|
||||
services:
|
||||
|
|
@ -420,7 +545,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' # Your LobeChat domain
|
||||
- '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"
|
||||
|
|
@ -459,9 +584,10 @@ volumes:
|
|||
driver: local
|
||||
s3_data:
|
||||
driver: local
|
||||
|
||||
```
|
||||
|
||||
### `minio-bucket-config.json`
|
||||
#### `minio-bucket-config.json`
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
|
|||
|
|
@ -46,14 +46,18 @@ tags:
|
|||
### 创建配置文件
|
||||
|
||||
```sh
|
||||
curl -fsSL https://raw.githubusercontent.com/lobehub/lobe-chat/HEAD/docker-compose/docker-compose.yml
|
||||
curl -fsSL https://raw.githubusercontent.com/lobehub/lobe-chat/HEAD/docker-compose/.env.zh-CN.example > .env
|
||||
curl -fsSL https://raw.githubusercontent.com/lobehub/lobe-chat/HEAD/docker-compose/local/docker-compose.yml
|
||||
curl -fsSL https://raw.githubusercontent.com/lobehub/lobe-chat/HEAD/docker-compose/local/.env.zh-CN.example > .env
|
||||
```
|
||||
|
||||
你也可以从下文的附录中复制得到这两份示例配置文件。
|
||||
|
||||
请按照注释，修改你的 `.env` 和 `docker-compose.yml` 文件。
|
||||
|
||||
<Callout type="warning">
|
||||
出于网络原因，本地启动时，我们特意让所有服务都同时使用了 `network_mode: host`。这可以解决一些网络问题，但是有可能会导致端口冲突，请自行解决。
|
||||
</Callout>
|
||||
|
||||
### 启动服务
|
||||
|
||||
```sh
|
||||
|
|
@ -194,6 +198,11 @@ docker logs -f lobe-database
|
|||
|
||||
### 配置文件
|
||||
|
||||
```sh
|
||||
curl -fsSL https://raw.githubusercontent.com/lobehub/lobe-chat/HEAD/docker-compose/production/docker-compose.yml
|
||||
curl -fsSL https://raw.githubusercontent.com/lobehub/lobe-chat/HEAD/docker-compose/production/.env.zh-CN.example > .env
|
||||
```
|
||||
|
||||
配置文件包括 `.env` 和 `docker-compose.yml` 两个文件，其中 `.env` 文件用于配置 LobeChat 的环境变量，`docker-compose.yml` 文件用于配置 Postgres、MinIO 和 Logto 服务。
|
||||
|
||||
一般情况下，你只应修改其中的域名和账号密码等敏感信息，其他配置项请按照默认值进行配置。
|
||||
|
|
@ -342,7 +351,121 @@ docker compose up -d # 重新启动
|
|||
|
||||
为方便一键复制，在此汇总配置服务端数据库所需要的示例配置文件：
|
||||
|
||||
### `.env`
|
||||
### 本地部署
|
||||
|
||||
#### `.env`
|
||||
|
||||
```sh
|
||||
# LobeChat 域名
|
||||
APP_URL=https://localhost:3210
|
||||
|
||||
# Postgres 相关，也即 DB 必须的环境变量
|
||||
# 用于加密敏感信息的密钥，可以使用 openssl rand -base64 32 生成
|
||||
KEY_VAULTS_SECRET=Kix2wcUONd4CX51E/ZPAd36BqM4wzJgKjPtz2sGztqQ=
|
||||
# Postgres 数据库连接字符串
|
||||
# 格式：postgres://username:password@host:port/dbname，如果你的 pg 实例与 LobeChat 服务在同一 Docker 网络中，可以使用容器名作为 host
|
||||
DATABASE_URL=postgresql://postgres:uWNZugjBqixf8dxC@localhost:5432/postgres
|
||||
|
||||
# NEXT_AUTH 相关，可以使用 auth0、Azure AD、GitHub、Authentik、Zitadel、Logto 等，如有其他接入诉求欢迎提 PR
|
||||
# 这里以 Logto 为例
|
||||
NEXT_AUTH_SECRET=NX2kaPE923dt6BL2U8e9oSre5RfoT7hg
|
||||
NEXT_AUTH_SSO_PROVIDERS=logto
|
||||
NEXTAUTH_URL=http://localhost:3210/api/auth
|
||||
LOGTO_CLIENT_ID=YOUR_LOGTO_CLIENT_ID
|
||||
LOGTO_CLIENT_SECRET=YOUR_LOGTO_CLIENT_SECRET
|
||||
LOGTO_ISSUER=http://localhost:3001/oidc
|
||||
# 注：如果你有 ACCESS_CODE，请务必清空，我们以 NEXT_AUTH 作为唯一鉴权来源
|
||||
# Proxy，如果你需要的话（比如你使用 GitHub 作为鉴权服务提供商）
|
||||
# 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=http://localhost:9000
|
||||
S3_BUCKET=lobe # 直到在 MinIO UI 中手动创建之前都是无效的
|
||||
S3_PUBLIC_DOMAIN=http://localhost:9000
|
||||
S3_ENABLE_PATH_STYLE=1
|
||||
|
||||
# 其他环境变量，视需求而定，可以参照客户端版本的环境变量配置，注意不要有 ACCESS_CODE
|
||||
# OPEANAI_API_KEY=sk-xxxx
|
||||
# OPENAI_PROXY_URL=https://api.openai.com/v1
|
||||
# OPENAI_MODEL_LIST=...
|
||||
|
||||
```
|
||||
|
||||
#### `docker-compose.yml`
|
||||
|
||||
```yaml
|
||||
services:
|
||||
postgresql:
|
||||
image: pgvector/pgvector:pg16
|
||||
container_name: lobe-postgres
|
||||
network_mode: 'host'
|
||||
volumes:
|
||||
- './data:/var/lib/postgresql/data'
|
||||
environment:
|
||||
- 'POSTGRES_DB=lobe'
|
||||
- 'POSTGRES_PASSWORD=uWNZugjBqixf8dxC'
|
||||
healthcheck:
|
||||
test: ['CMD-SHELL', 'pg_isready -U postgres']
|
||||
interval: 5s
|
||||
timeout: 5s
|
||||
retries: 5
|
||||
restart: always
|
||||
|
||||
minio:
|
||||
image: minio/minio
|
||||
container_name: lobe-minio
|
||||
network_mode: 'host'
|
||||
volumes:
|
||||
- './s3_data:/etc/minio/data'
|
||||
environment:
|
||||
- 'MINIO_ROOT_USER=YOUR_MINIO_USER'
|
||||
- 'MINIO_ROOT_PASSWORD=YOUR_MINIO_PASSWORD'
|
||||
- 'MINIO_DOMAIN=localhost:9000'
|
||||
- 'MINIO_API_CORS_ALLOW_ORIGIN=http://localhost:3210'
|
||||
restart: always
|
||||
command: >
|
||||
server /etc/minio/data --address ":9000" --console-address ":9001"
|
||||
|
||||
logto:
|
||||
image: svhd/logto
|
||||
container_name: lobe-logto
|
||||
network_mode: 'host'
|
||||
depends_on:
|
||||
postgresql:
|
||||
condition: service_healthy
|
||||
environment:
|
||||
- 'TRUST_PROXY_HEADER=1'
|
||||
- 'DB_URL=postgresql://postgres:uWNZugjBqixf8dxC@localhost:5432/logto'
|
||||
- 'ENDPOINT=http://localhost:3001'
|
||||
- 'ADMIN_ENDPOINT=http://localhost:3002'
|
||||
entrypoint: ['sh', '-c', 'npm run cli db seed -- --swe && npm start']
|
||||
|
||||
lobe:
|
||||
image: lobehub/lobe-chat-database
|
||||
container_name: lobe-database
|
||||
network_mode: 'host'
|
||||
depends_on:
|
||||
- postgresql
|
||||
- minio
|
||||
- logto
|
||||
env_file:
|
||||
- .env
|
||||
restart: always
|
||||
|
||||
volumes:
|
||||
data:
|
||||
driver: local
|
||||
s3_data:
|
||||
driver: local
|
||||
|
||||
```
|
||||
|
||||
### 发布到生产
|
||||
|
||||
#### `.env`
|
||||
|
||||
```sh
|
||||
# LobeChat 域名
|
||||
|
|
@ -360,13 +483,13 @@ DATABASE_URL=postgresql://postgres:uWNZugjBqixf8dxC@postgresql:5432/postgres
|
|||
NEXT_AUTH_SECRET=NX2kaPE923dt6BL2U8e9oSre5RfoT7hg
|
||||
NEXT_AUTH_SSO_PROVIDERS=logto
|
||||
NEXTAUTH_URL=https://lobe.example.com/api/auth
|
||||
LOGTO_CLIENT_ID=buc2lpttyo6evdtrfqsur
|
||||
LOGTO_CLIENT_SECRET=d97eztx8Ej6aUafeToMAL4jugAKGTAH4
|
||||
LOGTO_CLIENT_ID=YOUR_LOGTO_CLIENT_ID
|
||||
LOGTO_CLIENT_SECRET=YOUR_LOGTO_CLIENT_SECRET
|
||||
LOGTO_ISSUER=https://lobe-auth-api.example.com/oidc
|
||||
# 注：如果你有 ACCESS_CODE，请务必清空，我们以 NEXT_AUTH 作为唯一鉴权来源
|
||||
# Proxy，如果你需要的话（比如你使用 GitHub 作为鉴权服务提供商）
|
||||
HTTP_PROXY=http://localhost:7890
|
||||
HTTPS_PROXY=http://localhost:7890
|
||||
# HTTP_PROXY=http://localhost:7890
|
||||
# HTTPS_PROXY=http://localhost:7890
|
||||
|
||||
# MinIO S3 配置
|
||||
S3_ACCESS_KEY_ID=YOUR_S3_ACCESS_KEY_ID # 直到在 MinIO UI 中手动创建之前都是无效的
|
||||
|
|
@ -380,9 +503,10 @@ S3_ENABLE_PATH_STYLE=1
|
|||
# OPEANAI_API_KEY=sk-xxxx
|
||||
# OPENAI_PROXY_URL=https://api.openai.com/v1
|
||||
# OPENAI_MODEL_LIST=...
|
||||
|
||||
```
|
||||
|
||||
### `docker-compose.yml`
|
||||
#### `docker-compose.yml`
|
||||
|
||||
```yaml
|
||||
services:
|
||||
|
|
@ -415,7 +539,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"
|
||||
|
|
@ -454,9 +578,10 @@ volumes:
|
|||
driver: local
|
||||
s3_data:
|
||||
driver: local
|
||||
|
||||
```
|
||||
|
||||
### `minio-bucket-config.json`
|
||||
#### `minio-bucket-config.json`
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
|
|||
Loading…
Reference in a new issue