Skip to content

Commit 06dcb2c

Browse files
authored
Update README.md
1 parent 9560822 commit 06dcb2c

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,17 @@ Open an issue if you wish to contribute, or buy me a coffee if you find my work
3939
4040
## Configuration
4141
Edit the .env file, or specify these parameters as environment variables:
42+
```
43+
# Name of the database file to write into.
44+
SQLITE_FILE_PATH="databases/database.db"
4245

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

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

0 commit comments

Comments
 (0)