selfhosted
/
rustypaste
mirror of https://github.com/orhun/rustypaste.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs(readme): explain behavior of unset `auth_tokens` and `delete_tokens` (#202) 

* doc(readme): explain behavior of unset `auth_tokens` & `delete_tokens`

Just a clarification on how this works in the case of uninstalled tokens, for greater clarity and security

* docs(readme): update styling

* docs(readme): update grammar

---------

Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
This commit is contained in:
Artem Medvedev 2023-12-11 19:19:18 +01:00 committed by GitHub
parent c5c9c6d233
commit b74e9ceeaf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -252,6 +252,8 @@ Set `delete_tokens` array in [config.toml](./config.toml) to activate the [`DELE
$ curl -H "Authorization: <auth_token>" -X DELETE "<server_address>/file.txt"
```
> The `DELETE` endpoint will not be exposed and will return `404` error if `delete_tokens` are not set.
### Server
To start the server:
@ -275,6 +277,10 @@ $ rustypaste
You can also set multiple auth tokens via the array field `[server].auth_tokens` in your `config.toml`.
> If neither `AUTH_TOKEN` nor `[server].auth_tokens` are set, the server will not require any authentication.
>
> Exception is the `DELETE` endpoint, which requires at least one token to be set. See [deleting files from server](#delete-file-from-server) for more information.
See [config.toml](./config.toml) for configuration options.
#### List endpoint