SeanOMik
/
roulette
mirror of https://git.seedno.de/seednode/roulette.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated debug endpoint paths in readme

This commit is contained in:
Seednode 2023-06-03 18:09:17 -05:00
parent 72e41ba413
commit 1df552bc1e
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -72,18 +72,18 @@ This will slightly increase the delay before the application begins responding t
If any `include=`/`exclude=` filters are specified in a given request, the cache will be bypassed for that specific request. If any `include=`/`exclude=` filters are specified in a given request, the cache will be bypassed for that specific request.
The cache can be regenerated at any time by accessing the `/_/clear_cache` endpoint. The cache can be regenerated at any time by accessing the `/clear_cache` endpoint.
If `--cache-file` is set, the cache will be loaded from the specified file on start, and written to the file whenever it is re-generated. If `--cache-file` is set, the cache will be loaded from the specified file on start, and written to the file whenever it is re-generated.
## Statistics ## Statistics
If the `--stats` flag is passed, an additional endpoint, `/_/stats`, is registered. If the `--stats` flag is passed, an additional endpoint, `/stats`, is registered.
When accessed, this endpoint returns a JSON document listing every file served, along with the number of times it has been served, its filesize, and timestamps of when it was served. When accessed, this endpoint returns a JSON document listing every file served, along with the number of times it has been served, its filesize, and timestamps of when it was served.
## Debug ## Debug
If the `-d|--debug` flag is passed, two additional endpoints—`/_/html` and `/_/json`—are registered. If the `-d|--debug` flag is passed, two additional endpoints—`/html` and `/json`—are registered.
When accessed, these endpoints return the contents of the index, in HTML and JSON formats respectively. This can prove useful when confirming whether the index is generated successfully, or whether a given file is in the index. When accessed, these endpoints return the contents of the index, in HTML and JSON formats respectively. This can prove useful when confirming whether the index is generated successfully, or whether a given file is in the index.
@ -106,4 +106,4 @@ Flags:
--stats-file string path to optional persistent stats file --stats-file string path to optional persistent stats file
-v, --verbose log accessed files to stdout -v, --verbose log accessed files to stdout
-V, --version display version and exit -V, --version display version and exit
``` ```