mirror/pasty
1
0
Fork 0
mirror of https://github.com/lus/pasty.git synced 2023-08-10 21:13:09 +03:00
Code Issues Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Lukas SP 2020-08-23 16:37:14 +02:00
parent a3166a87f0
commit 7b8fab05a2
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,2 +1,19 @@
# pasty
Pasty is a fast and lightweight code pasting server
## General environment variables
| Environment Variable | Default Value | Type | Allowed Values | Description |
|-------------------------------|---------------|----------|-----------------|-------------------------------------------------------------------------------------------------------------|
| `PASTY_WEB_ADDRESS` | `:8080` | `string` | any | Defines the address the webs erver listens to |
| `PASTY_STORAGE_TYPE` | `file` | `string` | `file` | Defines the storage type the pastes are saved to |
| `PASTY_HASTEBIN_SUPPORT` | `false` | `bool` | `true`, `false` | Defines whether or not the `POST /documents` endpoint should be enabled, as known from the hastebin servers |
| `PASTY_DELETION_TOKEN_LENGTH` | `12` | `number` | any | Defines the length of the deletion token of a paste |
## Storage types
Pasty supports multiple storage types, defined using the `PASTY_STORAGE_TYPE` environment variable.
Every single one of them has its own configuration variables:
### File
| Environment Variable | Default Value | Type | Allowed Values | Description |
|---------------------------|---------------|----------|----------------|-----------------------------------------------------------|
| `PASTY_STORAGE_FILE_PATH` | `./data` | `string` | any | Defines the file path the paste files are being stored to |