docs: rewrite README with structured overview and quick start guide

Replaces the minimal project description with a comprehensive README
including a component overview table, quick start instructions, common
Ansible operations, and links to detailed documentation. Aligns with
Red Panda Approval™ standards.
This commit is contained in:
2026-03-03 12:49:06 +00:00
parent c7be03a743
commit b4d60f2f38
219 changed files with 34586 additions and 2 deletions

View File

@@ -0,0 +1,36 @@
services:
lobe-chat:
image: lobehub/lobe-chat-database:latest
pull_policy: always
environment:
- DATABASE_URL=postgresql://{{lobechat_db_user}}:{{lobechat_db_password}}@{{lobechat_db_host}}:{{lobechat_db_port}}/{{lobechat_db_name}}
- KEY_VAULTS_SECRET={{lobechat_key_vaults_secret}}
- NEXTAUTH_URL={{lobechat_nextauth_url}}
- NEXT_AUTH_SECRET={{lobechat_next_auth_secret}}
- NEXT_AUTH_SSO_PROVIDERS={{lobechat_next_auth_sso_providers}}
- AUTH_CASDOOR_ISSUER={{lobechat_auth_casdoor_issuer}}
- AUTH_CASDOOR_ID={{lobechat_auth_casdoor_id}}
- AUTH_CASDOOR_SECRET={{lobechat_auth_casdoor_secret}}
# Trust self-signed certificates for internal OIDC communication
- NODE_TLS_REJECT_UNAUTHORIZED=0
- S3_ENDPOINT={{lobechat_s3_endpoint}}
- S3_PUBLIC_DOMAIN={{lobechat_s3_public_domain}}
- S3_ACCESS_KEY_ID={{lobechat_s3_access_key}}
- S3_SECRET_ACCESS_KEY={{lobechat_s3_secret_key}}
- S3_BUCKET={{lobechat_s3_bucket}}
- SEARXNG_URL={{lobechat_searxng_url}}
- OPENAI_PROXY_URL={{lobechat_openai_proxy_url}}
- OPENAI_API_KEY={{lobechat_openai_key}}
- OLLAMA_PROXY_URL={{lobechat_ollama_proxy_url}}
- ANTHROPIC_API_KEY={{lobechat_anthropic_api_key}}
- GOOGLE_API_KEY={{lobechat_google_api_key}}
- APP_URL={{lobechat_app_url}}
logging:
driver: syslog
options:
syslog-address: "tcp://127.0.0.1:{{lobechat_syslog_port}}"
syslog-format: "{{syslog_format}}"
tag: "lobechat"
ports:
- "{{lobechat_port}}:3210"
restart: unless-stopped