No description
Find a file
Renovate Bot c76fce8253
All checks were successful
ci/woodpecker/push/lint Pipeline was successful
ci/woodpecker/push/build Pipeline was successful
chore(deps): update alpine docker tag to v3.20.1 (#28)
Co-authored-by: Renovate Bot <renovate@mgrote.net>
Co-committed-by: Renovate Bot <renovate@mgrote.net>
2024-06-20 22:06:29 +02:00
.woodpecker chore(deps): update zricethezav/gitleaks docker tag to v8.18.4 (#27) 2024-06-15 02:04:20 +02: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 fix linter errors 2024-05-08 14:19:23 +02:00
Dockerfile chore(deps): update alpine docker tag to v3.20.1 (#28) 2024-06-20 22:06:29 +02: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
renovate.json configure: renovatebot 2024-05-08 14:58:22 +02:00
requirements.txt chore(deps): update dependency requests to v2.32.3 (#23) 2024-05-30 02:01:09 +02:00
tests.sh Domainumstellung: grote.lan -> mgrote.net 2023-11-25 17:45:52 +01:00

python-api-server

status-badge

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/