wagtail-sharing 2.5.0

Setup

Install the package using pip:

$ pip install wagtail-sharing

Add wagtailsharing as an installed app in your Django settings:

# in settings.py
INSTALLED_APPS = (
    ...
    'wagtailsharing',
    ...
)

wagtail.contrib.modeladmin is also required and must be included in your list of installed apps.

Run migrations to create required database tables:

$ python manage.py migrate wagtailsharing

Replace use of Wagtail’s catch-all URL pattern:

# in urls.py
-from wagtail.core import urls as wagtail_urls
+from wagtailsharing import urls as wagtailsharing_urls

...

-urlpatterns.append(url(r'', include(wagtail_urls)))
+urlpatterns.append(url(r'', include(wagtailsharing_urls)))

Sharing sites

The Wagtail admin now contains a new section under Settings called Sharing Sites that allows users to define how they would like to expose latest page revisions.

No sharing sites exist by default. A sharing site must be manually created for each Wagtail Site to make its latest revisions shareable. Each sharing site is defined by a unique hostname and port number. Important: configuring your sharing sites improperly could expose draft/private content publicly. Be careful when setting them up!

Creating a new sharing site

After following the setup steps above, you should be able to create a new sharing site to use this functionality in a local Django development server. Let’s assume that you are running your local development server on the default port 8000, and that pages there are being served at http://localhost:8000. We want to create a new sharing site at http://sharing.localhost:8000 at which latest page revisions will be exposed.

To simulate accessing your site on a different hostname, you’ll need to loosen Django’s default security settings that only allow access on localhost. Edit your settings file (e.g. myproject/settings/local.py) to add the following:

ALLOWED_HOSTS = ['*']

Verify that you can access your local server at http://sharing.localhost:8000. You should see the same content there as on http://localhost:8000, as you haven’t enabled wagtail-sharing for the default site yet.

To do so, in the Wagtail admin, under Settings, Sharing Sites, create a new sharing site for the default site, with hostname sharing.localhost and port 8000.

Your latest page revisions (including drafts) should now be available at http://sharing.localhost:8000.

Banners

Pages viewed on a wagtail-sharing shared site have a simple banner added to them to remind reviewers that the current published content may differ from the content they are viewing.

This behavior can be disabled by setting settings.WAGTAILSHARING_BANNER = False. The banner template can be overridden by providing an alternate template file at wagtailsharing/banner.html similar to how wagtailadmin template overrides are supported.

Sharing links

A page’s sharing URL can be retrieved by passing its Page instance to wagtailsharing.helpers.get_sharing_url. This method returns None if no shared sites are configured or if the specified page is not routable to a shared site.

Shared pages will also have a new dropdown menu option that links to this sharing URL from the Wagtail page explorer.

Hooks

As with normal page serving, the serving of shared pages continues to respect Wagtail’s built-in before_serve_page hook.

This project adds these additional hooks:

from wagtail.core import hooks

@hooks.register('before_serve_shared_page')
def modify_shared_title(page, request, args, kwargs):
    page.title += ' (Shared)'

from wagtail.core import hooks

@hooks.register('after_serve_shared_page')
def add_custom_header(page, response):
    response['Wagtail-Is-Shared'] = '1'

Mixins

ShareableRoutablePageMixin

By default, Wagtail’s RoutablePageMixin is not compatible with Wagtail-Sharing, instead you need to use ShareableRoutablePageMixin in order to view share draft content fields on routable pages.

ShareableRoutablePageMixin is used exactly the same way as RoutablePageMixin:

from wagtail.core.fields import RichTextField
from wagtail.core.models import Page
from wagtail.contrib.routable_page.models import route
from wagtailsharing.models import ShareableRoutablePageMixin


class EventIndexPage(ShareableRoutablePageMixin, Page):
    intro = RichTextField()

    @route(r'^$')
    def current_events(self, request):
        # …

    @route(r'^past/$')
    def past_events(self, request):
        # …

Compatibility

This project has been tested for compatibility with:

• Python 3.6+

• Django 2.2 (LTS), 3.1 (current)

• Wagtail 2.7 (LTS), 2.10 (current)

It should be compatible with all intermediate versions, as well. If you find that it is not, please file an issue.

Open source licensing info

1. TERMS

2. LICENSE

3. CFPB Source Code Policy