Skip to content

Commit

Permalink
Merge pull request #9 from chez-shanpu/README
Browse files Browse the repository at this point in the history
READMEの追加
  • Loading branch information
chez-shanpu authored Jan 7, 2021
2 parents 819ce39 + f31bd72 commit 9c76823
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 2 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# secretary

## secretary-lab

### Getting Started

1. prepare `config.yaml`

```bash
$ cp sample-config.yaml config.yaml
```

```yaml
# config.yaml
users:
shanpu: # username
slack_id: "Uxxxxx" # user's slack id
slack_channel: "nil" # slack channel
secretary_name: "sample" # bot name
secretary_icon: ":slack:" # bot icon(your slack-workspace's custom icon name)
secretary_coming_msg: "" # bot message when you come
secretary_goodbye_msg: "" # bot message when you leave
rinse:
slack_id: ...
...

```

2. set environment vars in `docker-compose.yml`
- `LAB_SLACK_TOKEN`: slack bot token
- `LAB_SLACK_COMING_CHANNEL`: slack channel ID to report entry

3. run
```bash
$ docker-compose up -d
```
4 changes: 2 additions & 2 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ services:
# dockerfile: ./docker/secretary-lab/Dockerfile
# context: .
environment:
LAB_DB_USER: sample
LAB_DB_PASSWORD: sample
LAB_DB_USER: root
LAB_DB_PASSWORD: password
LAB_DB_PROTOCOL: tcp
LAB_DB_ADDR: mysql
LAB_DB_NAME: secretary
Expand Down

0 comments on commit 9c76823

Please sign in to comment.