From 1805c19025ce99735e7cbff8540f3e4078e5f2f8 Mon Sep 17 00:00:00 2001 From: Cameron Cordes Date: Thu, 30 Jul 2020 11:01:08 -0400 Subject: [PATCH] Add README with environment info --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..15dc76d --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Image API +This is an Actix-web server for serving images and videos from a filesystem. +Upon first run it will generate thumbnails for all images and videos at `DEFAULT_PATH`. + +## Environment +There are a handful of required environment variables to have the API run. +They should be defined where the binary is located or above it in an `.env` file. + +- `DATABASE_URL` is a path or url to a database (currently only SQLite is tested) +- `BASE_PATH` is the root from which you want to serve images and videos +- `THUMBNAILS` is a path where generated thumbnails should be stored +- `BIND_URL` is the url and port to bind to (typically your own IP address) +- `SECRET_KEY` is the *hopefully* random string to sign Tokens with +