GitMaya Save

首先，下载 docker-compose.yml 和 .env 文件；它们包含 GitMaya 服务的配置，包括 MySQL、Celery 和 Redis。

$ wget https://raw.githubusercontent.com/ConnectAI-E/GitMaya/main/deploy/docker-compose.yml
$ wget https://raw.githubusercontent.com/ConnectAI-E/GitMaya/main/deploy/.env.example -O .env

接下来，您需要配置 .env 文件。您应该用您在 步骤 1 中创建的 GitHub App 信息替换这些变量。

$ vim .env

将 GITHUB_APP_NAME、GITHUB_APP_ID、GITHUB_APP_PRIVATE_KEY、GITHUB_CLIENT_ID、GITHUB_CLIENT_SECRET、GITHUB_WEBHOOK_SECRET 替换到 .env 文件中

SECRET_KEY="<REPLACE>"
FLASK_PERMANENT_SESSION_LIFETIME=86400*30
FLASK_SQLALCHEMY_DATABASE_URI="mysql+pymysql://root:gitmaya2023@mysql:3306/gitmaya?charset=utf8mb4&binary_prefix=true"

GITHUB_APP_NAME=your-deploy-name
GITHUB_APP_ID=114514
GITHUB_APP_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
<replace you private key>
-----END RSA PRIVATE KEY-----"

GITHUB_CLIENT_ID=your_client_id
GITHUB_CLIENT_SECRET=your_client_secret

GITHUB_WEBHOOK_SECRET=secret
DOMAIN=127.0.0.1

NOTE: 文件支持多行字符串，因此.pem 文件可以直接粘贴到 .env 文件中

第一次运行时，它将初始化数据库，因此日志中可能包含一些错误消息。

$ docker-compose up -d

将仓库克隆到您的本地机器或服务器：

$ git clone https://github.com/ConnectAI-E/GitMaya.git
$ cd GitMaya

使用 pip

如果您使用 pip

$ pip install -r requirements.txt

使用 pdm（推荐）

如果您使用 pdm

$ pdm install

激活虚拟环境：

$ eval $(pdm venv activate)

在开始之前，请确保您具备以下配置文件：

• .env: 配置飞书、GitHub 和各种中间件变量。我们提供了一个 .env.example 作为参考

通过替换相关变量配置数据库

# 数据库设置
FLASK_SQLALCHEMY_DATABASE_URI="mysql+pymysql://root:gitmaya2023@mysql:3306/gitmaya?charset=utf8mb4&binary_prefix=true"

配置 Celery，使用 Redis 作为 Broker

# Celery 设置
CELERY_BROKER_URL=redis://redis:6379/1
CELERY_RESULT_BACKEND=redis://redis:6379/2

配置 GitHub App，详细信息请参考: 从零开始部署 GitHub App

# GitHub 设置
GITHUB_APP_NAME=test
GITHUB_APP_ID=1024
GITHUB_CLIENT_ID=test
GITHUB_CLIENT_SECRET=test
GITHUB_WEBHOOK_SECRET=secret
GITHUB_APP_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
<replace you private key>
-----END RSA PRIVATE KEY-----"

配置服务器地址

DOMAIN=127.0.0.1

（可选）配置 Flask

# Flask 设置
SECRET_KEY="test"
FLASK_PERMANENT_SESSION_LIFETIME=86400

启动 Redis：

$ docker run -d -p 6379:6379 redis:alpine

启动 Celery，使用 Redis 作为 Broker：

$ cd server
$ celery -A tasks.celery worker -l INFO -c 2

启动 MySQL：

$ docker run --name mysql -e MYSQL_ROOT_PASSWORD=gitmaya2023 -e MYSQL_DATABASE=gitmaya -e TZ=Asia/Shanghai -p 3306:3306 -v /path/to/your/mysql/data:/var/lib/mysql -v /path/to/your/mysql/conf.d:/etc/mysql/conf.d -d mysql:5.7 --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --sql_mode=STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION

创建数据库和表 （仅需要一次）：

$ flask --app server/server:app create

使用 gunicorn 运行 GitMaya 服务器：

$ gunicorn --worker-class=gevent --workers 1 --bind 0.0.0.0:8888 -t 600 --keep-alive 60 --log-level=info server:app