Add features section to README
parent
4bd1273a9d
commit
4889284016
20
README.md
20
README.md
|
@ -3,8 +3,24 @@
|
||||||
|
|
||||||
A dropbox backed by any S3 bucket
|
A dropbox backed by any S3 bucket
|
||||||
|
|
||||||
## Buckets
|
## Features
|
||||||
|
|
||||||
|
- User interface to create new dropboxes
|
||||||
|
- Store bucket credentials and settings in a Redis KV store
|
||||||
|
- Drop stored credentials when the dropbox link expires
|
||||||
|
- Upload files using S3 multipart uploads, powered by [Uppy](https://uppy.io)
|
||||||
|
- Remembers previously created dropboxes and uploaded files
|
||||||
|
- Single fat binary
|
||||||
|
|
||||||
|
## Deploying
|
||||||
|
|
||||||
|
To deploy as a single binary, build it from source and run:
|
||||||
|
|
||||||
|
```
|
||||||
|
export REDIS_CONNECTION=simple:redis-hostname:6379
|
||||||
|
export LISTEN=:8080
|
||||||
|
./upl
|
||||||
|
```
|
||||||
|
|
||||||
It is recommended to [configure the cleanup of incomplete multipart uploads](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpu-abort-incomplete-mpu-lifecycle-config.html).
|
|
||||||
|
|
||||||
<!-- vim: set conceallevel=2 et ts=2 sw=2: -->
|
<!-- vim: set conceallevel=2 et ts=2 sw=2: -->
|
||||||
|
|
Loading…
Reference in New Issue