File handler for django, useful when you want to add control or logic to served files.
It uses sendfile API supports on different servers and uses pythonic solution on django development server.
Currently it supports,
- Apache
- Nginx
- LightHttpd
- Caddy
- Proxygen
- H2O/Reproxy
- Hiawatha
use pip to install package:
pip install django-fileprovider
NOTE: if you are installing from github version consider checking releases
- add
fileproviderto djangoINSTALLED_APPSsection. - add
fileprovider.middleware.FileProviderMiddlewaretoMIDDLEWARE_CLASSESsection - set django
settingsfile withFILEPROVIDER_NAMEany of available providerspython,nginx,apache,lighthttpd,caddy,hiawatha,xsendfile,xaccel.
# or you can put FILEPROVIDER_NAME as python in your local settings file
if settings.DEBUG:
FILEPROVIDER_NAME = "python"
else:
# or apache, lighthttpd, caddy
FILEPROVIDER_NAME = "nginx"on django views where file response is required, fill response header X-File with absolute file path or use sendfile wrapper
for example,
from fileprovider.utils import sendfile
def hello(request):
return sendfile('/absolute/path/to/file')
# can be used protecting file access from unauthorized users
@login_required
def hello(request, file_id):
file = get_object_or_404(FileModel, pk=file_id)
return sendfile(file.path)