container-images/python-api-server
Archived
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases Activity Actions
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.
162 commits 2 branches 9 tags 256 KiB
Python 70.3%
Shell 12.9%
HTML 11%
Dockerfile 5.8%
Find a file
Michael Grote 9c90091625
All checks were successful
ci/woodpecker/push/lint Pipeline was successful
Details
ci/woodpecker/push/build Pipeline was successful
Details
add pylint (#15) 
Reviewed-on: #15
Co-authored-by: Michael Grote <michael.grote@posteo.de>
Co-committed-by: Michael Grote <michael.grote@posteo.de>
2024-05-08 14:49:20 +02:00
.woodpecker add pylint (#15) 2024-05-08 14:49: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 set alpine version 2024-03-13 08:53:28 +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
renovate.json Configure Renovate (#4) 2024-01-22 21:34:05 +01:00
requirements.txt chore(deps): update dependency flask-cors to v4.0.1 (#14) 2024-05-05 02:56:12 +02:00
tests.sh Domainumstellung: grote.lan -> mgrote.net 2023-11-25 17:45:52 +01:00

README.md

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/