add: readme

This commit is contained in:
Ada 2023-09-30 15:45:29 +00:00
parent ed90e12227
commit 3448294314

11
README.md Normal file
View file

@ -0,0 +1,11 @@
# A code share paste
## Run
Require redis and python, install python requirements with `pip install -r requirements.txt`. Run with `flask --app paste run` (add `--debug` for devlopement)
You can configure with multiple environnement variables.
- PASTE_REDIS_HOST: redis host (default localhost)
- PASTE_REDIS_PORT: redis port (default 6379)
- PASTE_REDIS_USER: redis username (default none)
- PASTE_REDIS_PASSWORD: redis password (default none)
- PASTE_URL_LENGTH: length for url used by paste
- PASTE_SECRET_KEY: secret key for flask, don't use the default value (generate a safe value with `openssl rand -hex 16`).