This repository has been archived on 2024-11-06. You can view files and clone it, but cannot push or open issues or pull requests.
python-api-server/README.md

38 lines
887 B
Markdown
Raw Normal View History

2023-04-13 14:50:46 +02:00
# python-api-server
2023-04-13 14:21:15 +02:00
2023-04-13 15:29:16 +02:00
a small flask-application for storing and downloading stuff like small binaries
2023-04-13 14:50:46 +02:00
## Variables
2023-04-13 14:21:15 +02:00
2023-04-14 07:41:42 +02:00
- ``MAX_CONTENT_LENGTH``: maximal Filesize in MB; defaults to 5MB
- ``UPLOAD_DIRECTORY``: where to store the uploaded files; should be mapped to a volume; defaults to "/uploads"
- ``AUTH_TOKEN``: token used for authenticating
2023-04-13 14:50:46 +02:00
## Example Docker-Compose
```yaml
version: '3'
services:
python-api-server:
container_name: httpd-api
image: quotengrote/python-api-server:v2
ports:
- "5040:5000"
volumes:
- uploads:/uploads
environment:
# FLASK_DEBUG: 1 # for debugging
# FLASK_APP: app # for debugging
MAX_CONTENT_LENGTH: 10
UPLOAD_DIRECTORY: /uploads
AUTH_TOKEN: myuploadtoken
2023-04-13 14:50:46 +02:00
volumes:
uploads:
2023-04-14 12:17:08 +02:00
```
## API-Endpoints
2023-04-14 12:17:08 +02:00
- see [Flasgger](https://github.com/flasgger/flasgger): ``http://<host>:5040/apidocs/``