yetangitu/timelimit-server
1
0
Fork 0
mirror of https://codeberg.org/timelimit/timelimit-server.git synced 2025-10-03 09:49:32 +02:00
Code Issues Projects Releases Wiki Activity

Add admin API description to the Readme

Browse source
This commit is contained in:
Jonas Lochmann 2020-01-13 00:00:00 +00:00
parent 93e441e821
commit 6ec8d25d78
No known key found for this signature in database
GPG key ID: 8B8C9AEE10FA5B36
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Readme.md
View file

@ -104,3 +104,15 @@ server {
} }
} }
``` ```
## Admin API
When the ``ADMIN_TOKEN`` environment variable was set, then there is a admin API available
at ``http(s)://server/admin``. This page is protected using HTTP basic authentication.
The username is ignored, the password is the admin token.
This allows to:
- see the counter for the websocket connections
- set a status message which is shown at all linked clients at the overview screen
- unlock the premium version feature for a user for a month or a year