ylqjgm
/
canvas-lms
mirror of https://github.com/instructure/canvas-lms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update some documentation 

Change-Id: I4120b2348ffa0d76361786762509c10645f429c3
Reviewed-on: https://gerrit.instructure.com/82013
Reviewed-by: Ryan Shaw <ryan@instructure.com>
Reviewed-by: Cody Cutrer <cody@instructure.com>
Product-Review: Simon Williams <simon@instructure.com>
QA-Review: Simon Williams <simon@instructure.com>
Tested-by: Jenkins
This commit is contained in:
Ben Nelson 2016-06-08 17:29:39 -06:00 committed by Simon Williams
parent 311434c267
commit 063f21ed1d
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/live_events.md
View File

@ -15,16 +15,16 @@ cli installed, and run the following command to create a stream (with
canvas running):
```bash
AWS_ACCESS_KEY_ID=key AWS_SECRET_ACCESS_KEY=secret aws --endpoint-url http://kinesis.docker/ kinesis create-stream --stream-name=mystream --shard-count=1
AWS_ACCESS_KEY_ID=key AWS_SECRET_ACCESS_KEY=secret aws --endpoint-url http://kinesis.docker/ kinesis create-stream --stream-name=mystream --shard-count=1 --region=us-east-1
```
Once the stream is created, configure your Canvas (at /plugins) to use
Once the stream is created, configure your Canvas (by visiting /plugins on your Canvas install) to use
it:
| Setting Name | Value |
| --------------------- | ------------------- |
| Kinesis Stream Name | mystream |
| AWS Region | (leave blank) |
| AWS Region | us-east-1 |
| AWS Endpoint | http://kinesis:4567 |
| AWS Access Key ID | key |
| AWS Secret Access Key | secret |
@ -33,5 +33,5 @@ Restart Canvas, and events should start flowing to your kinesis stream.
You can view the stream with the `tail_kinesis` tool:
```bash
fig run --rm web script/tail_kinesis kinesis 4567 mystream
docker-compose run --rm web script/tail_kinesis kinesis 4567 mystream
```