Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KerekesDavid authored Sep 3, 2024
1 parent 9560822 commit 06dcb2c
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,17 @@ Open an issue if you wish to contribute, or buy me a coffee if you find my work
## Configuration
Edit the .env file, or specify these parameters as environment variables:
```
# Name of the database file to write into.
SQLITE_FILE_PATH="databases/database.db"

```
# Name of the database file to write.
SQLITE_FILE_NAME="database.db"
# A list of secret keys. The server won't accept events that do not contain one of these keys in the request body.
API_KEYS=["I-am-an-unsecure-dev-key-REPLACE_ME"]

# A list of secret keys. The server won't accept events
# that do not contain one of these keys in the request body.
API_KEYS=["I-am-an-unsecure-dev-key-REPLACE_ME"]
```
# Requests from the same IP above this rate will be rejected.
# See https://limits.readthedocs.io/en/stable/quickstart.html#rate-limit-string-notation
RATE_LIMIT="60/minute"
```
## API
The server will listen to POST requests at `http://ip:port/v1.0/event`, and will expect a request body in the following format:
Expand Down

0 comments on commit 06dcb2c

Please sign in to comment.