Plane 还在早期阶段，还没有完全准备好，可能会出现一些小问题。请在 Discord 上告诉我们您在使用我们的工具时遇到的任何建议、想法或错误。

本指南假设您已经安装了 Docker，并具有运行 Docker 容器的权限。有关在您的机器上安装 Docker 的指南，请参阅在 Ubuntu 上安装 Docker 的指南。

使用 Docker Compose（推荐方式）

克隆存储库并更改目录

  1. git clone --depth 1 -b master https://github.com/makeplane/plane.git && cd plane

运行 setup.sh

此脚本使用您提供的 IP 地址或域名设置环境。

  1. ./setup.sh http://<your_ip|domain_name>

是您希望 Plane 实例可用的实际 IP 地址。

例如，如果您正在为自己设置 Plane，建议使用 localhost 作为 IP 地址。

环境变量

  1. # 前端
  2. # 需要添加到 Next Image 的额外图像域
  3. NEXT_PUBLIC_EXTRA_IMAGE_DOMAINS=
  4. # Google OAuth 的 Google 客户端 ID
  5. NEXT_PUBLIC_GOOGLE_CLIENTID=""
  6. # Github OAuth 的 Github ID
  7. NEXT_PUBLIC_GITHUB_ID=""
  8. # Github 集成的 Github App Name
  9. NEXT_PUBLIC_GITHUB_APP_NAME=""
  10. # Sentry DSN 用于错误监控
  11. NEXT_PUBLIC_SENTRY_DSN=""
  12. # 启用/禁用 OAUTH - 默认为 0，表示自托管实例
  13. NEXT_PUBLIC_ENABLE_OAUTH=0
  14. # 启用/禁用 Sentry
  15. NEXT_PUBLIC_ENABLE_SENTRY=0
  16. # 启用/禁用会话记录
  17. NEXT_PUBLIC_ENABLE_SESSION_RECORDER=0
  18. # 启用/禁用事件跟踪
  19. NEXT_PUBLIC_TRACK_EVENTS=0
  20. # Slack 集成的 Slack 客户端 ID
  21. NEXT_PUBLIC_SLACK_CLIENT_ID=""
  23. # 后端
  24. # API 服务器的调试值，将其用作 0 进行生产使用
  25. DEBUG=0
  27. # 错误日志
  28. SENTRY_DSN=""
  30. # 数据库设置
  31. PGUSER="plane"
  32. PGPASSWORD="plane"
  33. PGHOST="plane-db"
  34. PGDATABASE="plane"
  35. DATABASE_URL=postgresql://${PGUSER}:${PGPASSWORD}@${PGHOST}/${PGDATABASE}
  37. # Redis 设置
  38. REDIS_HOST="plane-redis"
  39. REDIS_PORT="6379"
  40. REDIS_URL="redis://${REDIS_HOST}:6379/"
  42. # 电子邮件设置
  43. EMAIL_HOST=""
  44. EMAIL_HOST_USER=""
  45. EMAIL_HOST_PASSWORD=""
  46. EMAIL_PORT=587
  47. EMAIL_FROM="Team Plane <team@mailer.plane.so>"
  48. EMAIL_USE_TLS="1"
  49. EMAIL_USE_SSL="0"
  51. # AWS 设置
  52. AWS_REGION=""
  53. AWS_ACCESS_KEY_ID="access-key"
  54. AWS_SECRET_ACCESS_KEY="secret-key"
  55. AWS_S3_ENDPOINT_URL="http://plane-minio:9000"
  56. # 如果使用 minio 设置，则需要更改 nginx.conf 以进行上传
  57. AWS_S3_BUCKET_NAME="uploads"
  58. # 最大文件上传限制
  59. FILE_SIZE_LIMIT=5242880
  61. # GPT 设置
  62. OPENAI_API_KEY=""
  63. GPT_ENGINE=""
  65. # Github
  66. GITHUB_CLIENT_SECRET="" # 用于获取发布说明
  68. # 与 Docker 相关的设置
  69. DOCKERIZED=1
  70. # 如果使用预配置的 minio 设置，则设置为 1
  71. USE_MINIO=1
  73. # Nginx 配置
  74. NGINX_PORT=80
  76. # 默认凭据
  77. DEFAULT_EMAIL="captain@plane.so"
  78. DEFAULT_PASSWORD="password123"
  80. # SignUps
  81. ENABLE_SIGNUP="1"
  82. # 自动生成且必须从 setup.sh 生成的
  83. NEXT_PUBLIC_API_BASE_URL=http://<your_ip|domain_name>
  84. SECRET_KEY="<redacted>"
  85. WEB_URL=http://<your_ip|domain_name>

使用 Docker Compose 启动 Plane

  1. docker compose -f docker-compose-hub.yml up

登录并享受新的、闪亮的 Plane 实例！

打开浏览器并导航到 http://你设置的IP或者域名/ 以登录到您的 Plane 实例。

Plane 自托管设置已更新至版本 0.7.1。如果您目前正在使用旧版本的 Plane，并在运行新容器后遇到数据库连接错误，很可能是由于 0.7.1 设置中 PostgreSQL 容器的用户名和密码更改。

要解决此错误，如果您之前使用的是默认密码和用户名，可以按照以下步骤操作： 将 PGUSER 设置为 plane，将旧密码设置为 PGPASSWORD=xyzzyspoon，在生成的环境文件中设置。重新启动容器。