From 7b8fab05a2cd969d2b2ea820f6e6d50d77baaf1f Mon Sep 17 00:00:00 2001 From: Lukas SP Date: Sun, 23 Aug 2020 16:37:14 +0200 Subject: [PATCH] Update readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index baf7e14..b0b0ea2 100644 --- a/README.md +++ b/README.md @@ -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 | \ No newline at end of file