Repository files navigation

django-storage-swift allows Django applications to use OpenStack Swiftas a file storage layer.

• Reads/writes files into/out of Swift.
• Automatically derives the correct URL to allow files to be accessedthrough a web browser based on information returned from theauthorisation server.
  • Allows you to override the host, port and path as necessary.
  • Supports the generation of temporary URLs to restrict access tofiles.

You can install django-storage-swift through pip. To store your mediafiles on swift, add the following line to your settings.py orlocal_settings.py:

DEFAULT_FILE_STORAGE='swift.storage.SwiftStorage'

To store your static files on swift, add the following line:

STATICFILES_STORAGE='swift.storage.StaticSwiftStorage'

This will use another container.

django-storage-swift recognises the following options.

django-swift-storage will automatically query the authentication serverfor the URL where your files can be accessed, which takes the formhttp://server:port/v1/AUTH_token/.

Sometimes you want to override the server and port (for example ifyou're developing usingdevstack insideVagrant). This can be accomplished withSWIFT_BASE_URL.

The provided value is parsed, and:

• host and port override any automatically derived values
• any path component is put before derived path components.

So if your auth server returnshttp://10.0.2.2:8080/v1/AUTH_012345abcd/ and you haveSWIFT_BASE_URL="http://127.0.0.1:8888/foo", theurl functionwill a path based onhttp://127.0.0.1:8888/foo/v1/AUTH_012345abcd/.

Temporary URLs provide a means to grant a user permission to access afile for a limited time only and without making the entire containerpublic.

Temporary URLs work as described in the Swift documentation. (The codeto generate the signatures is heavily based on their implementation.)They require setup of a key for signing: the process is described inthe OpenStackdocumentation.

Once installed and configured, use of django-storage-swift should beautomatic and seamless.

You can verify that swift is indeed being used by running, insidepython manage.py shell:

fromdjango.core.files.storageimportdefault_storagedefault_storage.http_conn

The result should be<<swiftclient.client.Connection object ...>>

To authenticate with a swift installation using Keystone AUTH and the Identity v3 API, you must also specify either the domain ID or name that your user and project (tenant) belongs to.

SWIFT_AUTH_URL='https://keystoneserver/v3'SWIFT_AUTH_VERSION='3'SWIFT_USERNAME='<<USERNAME>>'SWIFT_KEY='<<PASSWORD>>'SWIFT_TENANT_NAME='<<TENANT_NAME>>'SWIFT_USER_DOMAIN_NAME='<<DOMAIN_NAME>>'SWIFT_PROJECT_DOMAIN_NAME='<<DOMAIN_NAME>>'

• I'm getting permission errors accessing my files: If you are notusing temporary URLs, you may need to make the container publicallyreadable. Seethis helpfuldiscussion.If you are using temporary URLs, verify that your key is setcorrectly.
• I'm getting empty or truncated file uploads: Issues with some contenttypes may cause an incorrect content_length header to be sent with fileuploads, resulting in 0 byte or truncated files. To avoid this, setSWIFT_CONTENT_LENGTH_FROM_FD: True.

# This was executed on a VM running a SAIO, for example with# https://github.com/swiftstack/vagrant-swift-all-in-one# Create two world-readable containersswiftpost-r".r:*"djangoswiftpost-r".r:*"django-static# A virtualenv to keep installation separatedvirtualenvsampleenvsourcesampleenv/bin/activatepipinstalldjango-storage-swiftpipinstalldjango# Create a sample projectdjango-adminstartprojectsampleprojexportDJANGO_SETTINGS_MODULE=sampleproj.settingscdsampleproj/# A few required settings, using SAIO defaultscat<<EOF>>sampleproj/settings.pyDEFAULT_FILE_STORAGE='swift.storage.SwiftStorage'STATICFILES_STORAGE='swift.storage.StaticSwiftStorage'SWIFT_AUTH_URL='http://127.0.0.1:8080/auth/v1.0'SWIFT_USERNAME='test:tester'SWIFT_KEY='testing'SWIFT_CONTAINER_NAME='django'SWIFT_STATIC_CONTAINER_NAME='django-static'EOF# Create the initial DB datapythonmanage.pymigrate# This uploads static files to Swiftpythonmanage.pycollectstatic--noinput# Now open http://127.0.0.1:8000/admin/ in your browser# Static files like CSS are served by Swiftpythonmanage.pyrunserver