Installation¶
The easiest method is to install directly from pypi using pip by running the command below, which will also install the required dependencies mentioned above:
$ pip install mezzanine
If you prefer, you can download Mezzanine and install it directly from source:
$ python setup.py install
Once installed, the command mezzanine-project can be used to
create a new Mezzanine project in similar fashion to
django-admin.py:
$ mezzanine-project project_name
$ cd project_name
$ python manage.py createdb --noinput
$ python manage.py runserver
Note
The createdb command is a shortcut for using Django’s
migrate command, which will also install some demo content,
such as a contact form, image gallery, and more. If you’d like to
omit this step, use the --nodata option with createdb.
You should then be able to browse to http://127.0.0.1:8000/admin/ and
log in using the default account (username: admin, password:
default). If you’d like to specify a different username and password
during set up, simply exclude the --noinput option included above
when running createdb.
For information on how to add Mezzanine to an existing Django project, see the FAQ section of the documentation.
Mezzanine makes use of as few libraries as possible (apart from a standard Django environment), with the following dependencies, which unless noted as optional, should be installed automatically following the above instructions:
Python 3.7 to 3.10
`Django`_ 2.2 to 4.0
django-contrib-comments - for built-in threaded comments
Pillow - for image resizing (Python Imaging Library fork)
grappelli-safe - admin skin (Grappelli fork)
filebrowser-safe - for managing file uploads (FileBrowser fork)
bleach and BeautifulSoup - for sanitizing markup in content
chardet - for supporting arbitrary encoding in file uploads
django-modeltranslation - for multi-lingual content (optional)
django-compressor - for merging JS/CSS assets (optional)
requests and requests_oauthlib - for interacting with external APIs
Note that various systems may contain specialized instructions for installing Pillow.
Themes¶
A handful of attractive `Free Themes`_ are available thanks to @abhinavsohani.
Browser Support¶
Mezzanine’s admin interface works with all modern browsers including Google Chrome, Safari, Firefox and MS Edge. Internet Explorer and Edge < 79 are generally unsupported.
Third-Party Plug-Ins¶
The following plug-ins have been developed outside of Mezzanine. If you have developed a plug-in to integrate with Mezzanine and would like to list it here, send an email to the `mezzanine-users`_ mailing list, or better yet, fork the project and create a pull request with your plug-in added to the list below. We also ask that you add it to the Mezzanine Grid on djangopackages.com.
Cartridge - ecommerce for Mezzanine.
Drum - A Hacker News / Reddit clone powered by Mezzanine.
mezzanine-html5boilerplate - Integrates the html5boilerplate project into Mezzanine.
mezzanine-mdown - Adds Markdown support to Mezzanine’s rich text editor.
mezzanine-openshift - Setup for running Mezzanine on Redhat’s OpenShift cloud platform.
mezzanine-stackato - Setup for running Mezzanine on ActiveState’s Stackato cloud platform.
mezzanine-blocks - A Mezzanine flavored fork of django-flatblocks.
mezzanine-widgets - Widget system for Mezzanine.
mezzanine-themes - A collection of Django/Mezzanine templates.
mezzanine-twittertopic - Manage multiple Twitter topic feeds from the Mezzanine admin interface.
mezzanine-captcha - Adds CAPTCHA field types to Mezzanine’s forms builder app.
mezzanine-bookmarks - A multi-user bookmark app for Mezzanine.
mezzanine-events - Events plugin for Mezzanine, with geocoding via Google Maps, iCalendar files, webcal URLs and directions via Google Calendar/Maps.
mezzanine-polls - Polls application for Mezzanine.
mezzanine-pagedown - Adds the Pagedown WYSIWYG editor to Mezzanine.
mezzanine-careers - Job posting application for Mezzanine.
mezzanine-recipes - Recipes plugin with built-in REST API.
mezzanine-slides - Responsive banner slides app for Mezzanine.
mezzyblocks - Another app for adding blocks/modules to Mezzanine.
mezzanine-flexipage - Allows designers to manage content areas in templates.
mezzanine-instagram - A simple Instagram app for Mezzanine.
mezzanine-wiki - Wiki app for Mezzanine.
mezzanine-calendar - Calendar pages in Mezzanine
mezzanine-facebook - Simple Facebook integration for Mezzanine.
mezzanine-instagram-gallery - Create Mezzanine galleries using Instagram images.
mezzanine-cli - Command-line interface for Mezzanine.
mezzanine-categorylink - Integrates Mezzanine’s Link pages with its blog categories.
mezzanine-podcast - A simple podcast streamer and manager for Mezzanine.
mezzanine-linkcollection - Collect links. Feature them. Share them over RSS.
cash-generator - Generate GnuCash invoices with Mezzanine.
mezzanine-foundation - Zurb Foundation theme for Mezzanine.
mezzanine-file-collections - Simple file collection page type for Mezzanine.
mezzanine-wymeditor - WYMeditor adapted as the rich text editor for Mezzanine.
mezzanine-meze - Adds support for reStructuredText, Pygments and more, to Mezzanine’s rich text editing.
mezzanine-pageimages - Add background and banner images per page in Mezzanine.
mezzanine-protected-pages - Restrict access to pages by group membership.
mezzanine-page-auth - A Mezzanine module for add group-level permission to pages.
django-widgy - Widget-oriented content editing. Includes an adapter for Mezzanine and a powerful form builder.
mezzanine-admin-backup - Export your Mezzanine database and assets directly from the admin.
mezzanine-mailchimp - Integrate Mezzanine forms with a MailChimp subscription list.
mezzanine-grappelli - Integrates latest upstream grappelli/filebrowser with Mezzanine.
mezzanine-workout - Store and display FIT data in Mezzanine.
mezzanine-agenda - Event functionality for your Mezzanine sites.
mezzanine-dpaste - Integrate dpaste, a Django pastebin, into your Mezzanine site.
mezzanine-linkdump - Create, display and track links in Mezzanine.
mezzanine-people - Categorize and list people in Mezzanine.
mezzanine-webf - Fabfile for deploying Mezzanine to Webfaction.
mezzanineopenshift Another setup for Redhat’s OpenShift cloud platform.
mezzanine-bsbanners - Add `Twitter Bootstrap`_ Carousels and Jumbotrons to Mezzanine.
mezzanine-business-theme - Starter business theme for Mezzanine.
open-helpdesk - A helpdesk app built with Mezzanine.
mezzanine-invites - Allow site registration via alphanumeric invite codes.
ansible-mezzanine - Full pipeline (dev, staging, production) deployment of Mezzanine using Ansible.
mezzanine-modal-announcements - Popup announcements for Mezzanine websites via Bootstrap modals.
mezzanine-buffer - Buffer integration for Mezzanine.
mezzanine-slideshows - Allows placement of Mezzanine galleries within other Mezzanine pages as slideshows.
mezzanine-onepage - Design helper for single-page Mezzanine sites.
mezzanine-api - RESTful web API for Mezzanine.
mezzanine-smartling - Integrates Mezzanine content with Smartling Translations.
mezzanine-shortcodes - Wordpress shortcodes for Mezzanine.
Sites Using Mezzanine¶
Got a site built with Mezzanine? You can add it to the gallery on the `Mezzanine project page`_ by adding it to the list below - just fork the project and create a pull request. Please omit the trailing slash in the URL, as we manually add that ourselves to feature certain sites.