Merge pull request #211 from beproud/t210-add-REDMINE_API_KEY-to-READ…

…ME-env.sample REDMINE_API_KEYについて追記
beproud · Oct 30, 2020 · 5381b87 · 5381b87
2 parents a4007e9 + d6565e1
commit 5381b87
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/ChangeLog.rst b/ChangeLog.rst
@@ -2,6 +2,10 @@
 Unreleased
 ----------
 
+Release Notes - 2020-10-30
+--------------------------
+- [#210] READMEとenv.sampleにREDMINE_API_KEYについて追記
+
 Release Notes - 2020-10-23
 --------------------------
 - [#207] Redmine Reminderが動いていないバグ

diff --git a/README.md b/README.md
@@ -31,6 +31,12 @@ $ source /path/env/bin/activate
 (env)$ pip install -r src/requirements.txt
 ```
 
+### Redmine APIキーの取得
+
+ `.env` に`REDMINE_API_KEY` を指定する必要がある。
+
+ローカル環境では、 `BPのRedmine > 個人設定 > APIアクセスキー > 表示` で確認できるAPIキーを `.env` に追記する。
+
 ## 起動方法
 
 ```bash

diff --git a/env.sample b/env.sample
@@ -14,6 +14,7 @@ SQLALCHEMY_URL=sqlite:///haro.sqlite
 SQLALCHEMY_ECHO=true or false
 #SQLALCHEMY_POOL_SIZE=20
 WATER_EMPTY_TO=user_group_id
+REDMINE_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxx
 
 # ansible
 # ENVIRONMENT_FILE_PATH=/home/haro/beproudbot/.env