Skip to main content

This application allows you easily save media and static files into webdav storage

Project description

Travis CI build status Code coverage percentage Latest version on PyPI Wheel Status Supported Python versions

This application allows you easily save media and static files into webdav storage.

Dependencies

Installation

  1. Install the package
pip install django-webdav-storage
  1. Pick the webdav server url in WEBDAV_URL and WEBDAV_PUBLIC_URL:
WEBDAV_URL = 'http://webdav.example.com/',
WEBDAV_PUBLIC_URL = 'http://webdav.example.com/'

If you want use HTTP Basic authorization to webdav access, you can specify your credentials like that:

WEBDAV_URL = 'http://johndoe:secret@webdav.example.com/'
  1. Set the webdav storage class as default:
DEFAULT_FILE_STORAGE = 'django_webdav_storage.storage.WebDavStorage'
  1. If your webdav backend can’t recursively create path (e.g. nginx can do this, while apache can’t), set the WEBDAV_RECURSIVE_MKCOL variable to True:
WEBDAV_RECURSIVE_MKCOL = True
  1. If you use nginx as webdav server and want to enable storage directory listing, set the WEBDAV_LISTING_BACKEND option to:
WEBDAV_LISTING_BACKEND = 'django_webdav_storage.listing.nginx_autoindex'

Autoindex feature must be enabled in your nginx configuration for application servers (see example below). Be careful! Allowing autoindex for any user may lead to security and performance issues.

Also, you may specify path to other function with the following interface:

def listdir(storage_object, path_string):
    return dirs_list, files_list

The nginx webdav configuration example

# Public readonly media server.
server {
    listen 80;
    charset        utf-8;
    server_tokens  off;
    server_name    media.example.com;

    access_log     /var/log/nginx/media_access.log;
    error_log      /var/log/nginx/media_error.log;

    root           /usr/share/nginx/webdav;

}

# WebDAV server
server {
    listen 80;
    charset        utf-8;
    server_tokens  off;
    server_name    webdav.example.com;

    access_log     /var/log/nginx/webdav_access.log;
    error_log      /var/log/nginx/webdav_error.log;

    root           /usr/share/nginx/webdav;

    client_max_body_size    10m;
    client_body_temp_path   /tmp;
    create_full_put_path    on;
    autoindex               on;

    dav_methods             PUT DELETE MKCOL COPY MOVE;
    dav_access              user:rw   group:r   all:r;

    satisfy                 any;

    allow                   127.0.0.1/32;
    deny                    all;

    auth_basic              'My WebDAV area';
    auth_basic_user_file    /usr/share/nginx/.htpasswd;
}

Caveats

  • In python 3.x ContentFile with text mode content (not binary one) will causes TypeError due requests restrictions

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dj-webdav-storage-0.6.1.tar.gz (6.4 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page