Skip to content

Commit

Permalink
Added example for AWS config
Browse files Browse the repository at this point in the history
Added an example for the AWS configuration. It took quite a bit to figure out that there should be no leading or trailing "/" for deeper directory structures.
  • Loading branch information
JimnyCricket authored Mar 7, 2020
1 parent a8ce5da commit 0accb15
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,22 @@ Notes:
3. On save, Gecko will override the annotation file and save another file with a timestamp, to maintain some kind of primitive history mechanism.
4. You can have multiple annotation files, just aggregate them using `;` : `http://localhost:8080/?save_mode=server&audio=http://localhost:8080/s3_files/file.mp3&json=http://localhost:8080/s3_files/annotation_1.json;http://localhost:8080/s3_files/annotation_2.json`

Example:

For an audio file and corresponding annotation file:
`s3://example-audio-bucket/my-audio/file.mp3`
and
`s3://example-audio-bucket/my-audio/annotation.json`
the .env file would be:

```bash
AWS_BUCKET=example-audio-bucket
AWS_REGION=<<<something like us-east-3>>>
AWS_ACCESS_KEY_ID=<<<aws access key id>>>
AWS_SECRET_ACCESS_KEY=<<<aws secret access key>>>
AWS_FOLDER=my-audio # no leading or trailing "/"
```

## Deploy

### Client mode
Expand Down

0 comments on commit 0accb15

Please sign in to comment.