tyler/proc-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add proposed documentation

Browse Source
This commit is contained in:
Tyler Perkins 2022-04-29 15:57:25 -04:00
parent 146d31efea
commit 0a9af99427
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
DOCUMENTATION.md
View File

@ -19,6 +19,16 @@ types
* Returns exact response from the `/proc` file system * Returns exact response from the `/proc` file system
* For more about the format of these responses, refer to the proc(5) manpage * For more about the format of these responses, refer to the proc(5) manpage
Security tokens
---------------
The application provides the `-a` flag, which accepts a path as a required
argument. The file specified in the path should contain a series of strings,
each on a new line. Each line represents a valid token that the client can send
to authorize the request. This token must be send in a `Authorization:` header.
If the token is not given, or the wrong token is given, the server will instead
return a 403.
Proc file responses Proc file responses
============ ============