2020-08-22 23:09:17 +03:00
# pasty
Pasty is a fast and lightweight code pasting server
2020-08-23 17:37:14 +03:00
## General environment variables
2020-08-24 00:44:47 +03:00
| Environment Variable | Default Value | Type | Description |
|-------------------------------|---------------|----------|-------------------------------------------------------------------------------------------------------------|
2020-08-24 19:06:14 +03:00
| `PASTY_WEB_ADDRESS` | `:8080` | `string` | Defines the address the web server listens to |
2020-08-24 00:44:47 +03:00
| `PASTY_STORAGE_TYPE` | `file` | `string` | Defines the storage type the pastes are saved to |
| `PASTY_HASTEBIN_SUPPORT` | `false` | `bool` | Defines whether or not the `POST /documents` endpoint should be enabled, as known from the hastebin servers |
2020-08-24 21:22:53 +03:00
| `PASTY_ID_LENGTH` | `6` | `number` | Defines the length of the ID of a paste |
2020-08-24 00:44:47 +03:00
| `PASTY_DELETION_TOKEN_LENGTH` | `12` | `number` | Defines the length of the deletion token of a paste |
| `PASTY_RATE_LIMIT` | `30-M` | `string` | Defines the rate limit of the API (see https://github.com/ulule/limiter#usage) |
2020-08-23 17:37:14 +03:00
## Storage types
2020-08-24 00:44:47 +03:00
Pasty supports multiple storage types, defined using the `PASTY_STORAGE_TYPE` environment variable (use the value behind the corresponding title in this README).
2020-08-23 17:37:14 +03:00
Every single one of them has its own configuration variables:
2020-08-24 00:44:47 +03:00
### File (`file`)
| Environment Variable | Default Value | Type | Description |
|---------------------------|---------------|----------|-----------------------------------------------------------|
2020-08-24 19:06:14 +03:00
| `PASTY_STORAGE_FILE_PATH` | `./data` | `string` | Defines the file path the paste files are being saved to |
2020-08-24 00:44:47 +03:00
2020-08-24 21:22:53 +03:00
---
2020-08-24 00:44:47 +03:00
### S3 (`s3`)
| Environment Variable | Default Value | Type | Description |
|--------------------------------|---------------|----------|-------------------------------------------------------------------------------------------|
| `STORAGE_S3_ENDPOINT` | `<empty>` | `string` | Defines the S3 endpoint to connect to |
| `STORAGE_S3_ACCESS_KEY_ID` | `<empty>` | `string` | Defines the access key ID to use for the S3 storage |
| `STORAGE_S3_SECRET_ACCESS_KEY` | `<empty>` | `string` | Defines the secret acces key to use for the S3 storage |
| `STORAGE_S3_SECRET_TOKEN` | `<empty>` | `string` | Defines the session token to use for the S3 storage (may be left empty in the most cases) |
| `STORAGE_S3_SECURE` | `true` | `bool` | Defines whether or not SSL should be used for the S3 connection |
| `STORAGE_S3_REGION` | `<empty>` | `string` | Defines the region of the S3 storage |
2020-08-24 20:18:05 +03:00
| `STORAGE_S3_BUCKET` | `pasty` | `string` | Defines the name of the S3 bucket (has to be created before setup) |
2020-08-24 21:22:53 +03:00
---
2020-08-24 20:18:05 +03:00
### MongoDB (`mongodb`)
| Environment Variable | Default Value | Type | Description |
|-------------------------------------|--------------------------------------------|----------|-----------------------------------------------------------------|
| `STORAGE_MONGODB_CONNECTION_STRING` | `mongodb://pasty:pasty@example.host/pasty` | `string` | Defines the connection string to use for the MongoDB connection |
| `STORAGE_MONGODB_DATABASE` | `pasty` | `string` | Defines the name of the database to use |
| `STORAGE_MONGODB_COLLECTION` | `pastes` | `string` | Defines the name of the collection to use |
