odyseusz/publapi
1
0
Fork 0
forked from ProjectSegfault/publapi
Code Pull Requests Activity

add SHOUTRRRURL docs

Browse Source
This commit is contained in:
Arya Kiran
2023-01-08 14:50:40 +05:30
parent 90478283d6
commit e74b19616c
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -11,7 +11,9 @@ go build
./publapi
```
By default it listens to port 3000 on 127.0.0.1. You can change the port with the environment variable PUBLAPI_PORT.
By default publapi listens on 127.0.0.1:3000. You can change the port with the environment variable PUBLAPI_PORT.
Additionally, you need to set the variable PUBLAPI_SHOUTRRRURL in order for notifications to work. Url Format can be found at https://containrrr.dev/shoutrrr/v0.5/services/matrix/
## Usage
Currently, PublAPI has only two routes, /online and /signup.
@@ -20,4 +22,3 @@ Currently, PublAPI has only two routes, /online and /signup.
|---------|------|-----------------|------------------------------------|
| /online | GET | N/A | Returns the number of online users |
| /signup | POST | username, email | Creates a register script and notifies admins that a new registration request was sent |