Skip to content

Commit

Permalink
Add basic installation instructions in the README (#25)
Browse files Browse the repository at this point in the history
  • Loading branch information
Steffo99 committed Sep 27, 2023
1 parent 8e12ce3 commit 8cdd419
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,24 @@ A web API that allowing applications to manage achievements which can be unlocke

[![Website](https://img.shields.io/website?url=https%3A%2F%strawberry.ryg.one%2F)](https://strawberry.ryg.one/)

## Installation

Use the provided Docker image, configuring the following environment variables:

`IS_DB_URI`
: SQLAlchemy engine URL to use to select the database.

`IS_WEB_HOST`
: Host to bind the webserver to.

`IS_WEB_PORT`
: TCP port to bind the webserver to.

`IS_SECRET`
: Secret used for administration tasks.

`CORS_ALLOW_ORIGINS`
: Origins to return in the `Access-Control-Allow-Origins` header.

## Roadmap

Expand Down

0 comments on commit 8cdd419

Please sign in to comment.