Archived

No description

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.

Find a file

Michael Grote 15eec18863 FROM alpine:3		2023-11-08 16:27:34 +01:00
.woodpecker	ci: disable shellcheck	2023-11-08 16:20:39 +01:00
assets	add web-ui (#3 )	2023-04-26 19:53:12 +02:00
templates	add web-ui (#2 )	2023-04-26 19:51:53 +02:00
app.py	add web-ui (#2 )	2023-04-26 19:51:53 +02:00
Dockerfile	FROM alpine:3	2023-11-08 16:27:34 +01:00
gunicorn_config.py	test logging	2023-04-13 15:18:23 +02:00
README.md	add badge	2023-11-08 13:24:02 +01:00
requirements.txt	remove explicit set versions	2023-10-03 18:07:58 +02:00
tests.sh	add docs + test	2023-04-14 12:20:04 +02:00

README.md

python-api-server

a small flask-application for storing and downloading stuff like small binaries

Variables

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

Example Docker-Compose

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
      ENABLE_WEBSERVER: true # if enabled a list of files can be viewed in a webbrowser (see screenshot)

volumes:
  uploads:

ENABLE_WEBSERVER Screenshot

API-Endpoints

see Flasgger: http://<host>:5040/apidocs/