Skip to main content

An S3 fix for Mezzanine's media manager.

Project description

# filebrowser_s3: an AWS S3 fix for Mezzanine's media manager

This app overrides the default Mezzanine filebrowser to do "the same but then using AWS S3".

## Installation

Use pip:

```
$> pip install filebrowser_s3
```

## Using filebrowser_s3 with Mezzanine

In your Mezzanine settings.py (or local settings file), add filebrowser_s3 as an installed app:

```
INSTALLED_APPS = [
...,
'filebrowser_s3',
]
```

You will need to make sure that the correct storage class is used as `DEFAULT_FILE_STORAGE`. You could do this with a straight assignment, but conditional switching is recommended, as in the following example code assumes an `env()` function for intelligently fetching environment variables):

```
# Determine which storage solution to use. Typically, you
# want filesystem storage for local dev work, but S3 storage
# for staging/production instances.
USE_S3 = env('USE_S3')

if USE_S3:
DEFAULT_FILE_STORAGE = 'filebrowser_s3.storage.S3MediaStorage'

AWS_ACCESS_KEY_ID = env('AWS_ACCESS_KEY_ID')
AWS_SECRET_ACCESS_KEY = env('AWS_SECRET_ACCESS_KEY')
AWS_STORAGE_BUCKET_NAME = env('AWS_STORAGE_BUCKET_NAME')

MEDIA_ROOT = ''

AWS_S3_CUSTOM_DOMAIN = env('AWS_S3_CUSTOM_DOMAIN', default=None)
if AWS_S3_CUSTOM_DOMAIN is None:
MEDIA_URL = '...your public AWS bucket URL with protocol and trailing slash'
else:
MEDIA_URL = 'https://' + AWS_S3_CUSTOM_DOMAIN + '/'

FILEBROWSER_DIRECTORY = env('AWS_UPLOAD_DIRECTORY', default='')

else:
MEDIA_ROOT = ...
MEDIA_URL = ...
```

## Variables documentation

When using the s3 storage class, the variables required to be set are:

- `DEFAULT_FILE_STORAGE`- This must be `filebrowser_s3.storage.S3MediaStorage` for obvious reasons.
- `AWS_ACCESS_KEY_ID` - Your AWS access key.
- `AWS_SECRET_ACCESS_KEY` - Your AWS secret.
- `AWS_STORAGE_BUCKET_NAME` - The bucket name to use on your AWS account.
- `AWS_S3_CUSTOM_DOMAIN` - Whatever custom domain you need used, such as "assets.mydomain.com".
- `MEDIA_ROOT` - The Mezzanine filesystem root. When using the S3 storage class this should be set to `''`.
- `MEDIA_URL` - The fully qualified domain URL that Mezzanine can link to. This includes the protocol and trailing slash, and so will typically be of the form `'https://' + AWS_S3_CUSTOM_DOMAIN + '/'`.
- `FILEBROWSER_DIRECTORY` - The name of the "root directory" in your bucket for media uploads. Note that according to the filebrowser documentation on the Django website, this value should end in a trailing `/`

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

filebrowser_s3-0.1.17.tar.gz (6.8 kB view details)

Uploaded Source

File details

Details for the file filebrowser_s3-0.1.17.tar.gz.

File metadata

File hashes

Hashes for filebrowser_s3-0.1.17.tar.gz
Algorithm Hash digest
SHA256 c501ad95a9177e39c9d8c0fa56408047e51f73b93f8cd96111736efc728bdebc
MD5 99b727981a5bc6407bce78867cb3d883
BLAKE2b-256 c0ecbb34c462dbd0aa5f758e65215654e637b9cccf6cc129fb23cb42dc5d1e86

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page