Skip to main content

Easier sharing of Wagtail drafts

Project description

Build Status Coverage Status

wagtail-sharing

Easier sharing of Wagtail drafts.

Wagtail Sharing makes it easier to share Wagtail draft content for review by users who don’t have access to the Wagtail admin site. It allows you to define an alternate hostname and/or port on which to expose the latest revision of all of your Wagtail pages.

For example, let’s say your Wagtail site is running on http://mysite.com. You’ve created a draft page at slug /path/to/draft, but haven’t yet published it. Wagtail Sharing lets you expose that draft page at some other domain, for example http://sharing.mysite.com/path/to/draft.

In another use case, you might have a published page at http://mysite.com/already/published/page, and you’ve made some draft changes. Wagtail Sharing lets you expose those draft changes at http://sharing.mysite.com/already/published/page while still keeping the same published content at your regular domain.

These examples obviously work best when you have some method of restricting access to http://sharing.mysite.com, for example by only exposing that subdomain on a private network.

Wagtail Sharing lets you create separate sharing sites for each Wagtail Site you have defined. It also supports a configurable visual banner on shared pages to remind reviewers that content may differ from your published site.

This new logic only applies to GET requests. Other HTTP methods like POST defer to standard Wagtail handling.

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',
    ...
)

Run migrations to create required database tables:

$ manage.py migrate wagtailsharing

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

# in urls.py
-from wagtail.wagtailcore 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.

Sharing sites

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!

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.

Banner

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.

Compatibility

This project has been tested for compatibility with:

  • Python 2.7, 3.5

  • Django 1.8, 1.9, 1.10

  • Wagtail 1.6, 1.7, 1.8, 1.9

Open source licensing info

  1. TERMS

  2. LICENSE

  3. CFPB Source Code Policy

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

wagtail-sharing-0.5.tar.gz (12.5 kB view details)

Uploaded Source

File details

Details for the file wagtail-sharing-0.5.tar.gz.

File metadata

File hashes

Hashes for wagtail-sharing-0.5.tar.gz
Algorithm Hash digest
SHA256 a00f92f746589d05b9afdc89d487d51bf2363c32d5c8f87f75d9712068e5b690
MD5 c02aa60424f177832fbd49b55742e52b
BLAKE2b-256 6d8d7199da630c74cac8fff7533dfd5498b4c6533d074377382879824e1d3847

See more details on using hashes here.

Provenance

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