moving pages around envs

  Changes Made

  1. Removed wagtailimportexport/ — the entire vendored package directory
  2. Added wagtail-transfer==0.11 to requirements/base.txt
  3. Replaced wagtailimportexport with wagtail_transfer in INSTALLED_APPS (openstax/settings/base.py)
  4. Added wagtail-transfer settings to base.py — configurable via env vars:
    - WAGTAILTRANSFER_SECRET_KEY — this instance's auth key
    - WAGTAILTRANSFER_SOURCE_NAME / _URL / _KEY — defines the source to pull from
  5. Added URL route wagtail-transfer/ in openstax/urls.py (above the catch-all wagtail route)

  What's Needed Next

  Per-environment setup:

  On each environment, set these env vars:

  # On production — pull from staging
  WAGTAILTRANSFER_SECRET_KEY=<prod-secret>
  WAGTAILTRANSFER_SOURCE_NAME=staging
  WAGTAILTRANSFER_SOURCE_URL=https://staging.openstax.org/wagtail-transfer/
  WAGTAILTRANSFER_SOURCE_KEY=<staging-secret>

  # On staging — the secret key must match what prod uses as SOURCE_KEY
  WAGTAILTRANSFER_SECRET_KEY=<staging-secret>

  The SECRET_KEY on the source must match the SOURCE_KEY configured on the destination.

  Run migrations on each environment:
  python manage.py migrate wagtail_transfer

  Permissions: Superusers get access automatically. For other users, create a group with the "Can import pages and
  snippets from other sites" permission.

  Usage: In Wagtail admin, there will be a new "Import" option. You browse the source environment's page tree and
  select what to pull in — no more zip files.

Author: mwvolo

openstax/settings/base.py

@@ -249,7 +249,7 @@
     'oxauth',
     'webinars',
     'donations',
-    'wagtailimportexport',
+    'wagtail_transfer',
     'versions',
     'oxmenus',
     # wagtail
@@ -270,6 +270,27 @@
     'wagtail.contrib.settings',
 ]
 
+####################
+# Wagtail Transfer #
+####################
+
+WAGTAILTRANSFER_SECRET_KEY = os.getenv('WAGTAILTRANSFER_SECRET_KEY', 'change-me-in-production')
+
+# Configure sources to import content from.
+# Each environment should define the sources it can pull from.
+# Example: on prod, you might pull from staging; on local, from staging or prod.
+# Override in environment-specific settings or via env vars.
+WAGTAILTRANSFER_SOURCES = {}
+
+_transfer_source_name = os.getenv('WAGTAILTRANSFER_SOURCE_NAME')
+_transfer_source_url = os.getenv('WAGTAILTRANSFER_SOURCE_URL')
+_transfer_source_key = os.getenv('WAGTAILTRANSFER_SOURCE_KEY')
+if _transfer_source_name and _transfer_source_url and _transfer_source_key:
+    WAGTAILTRANSFER_SOURCES[_transfer_source_name] = {
+        'BASE_URL': _transfer_source_url,
+        'SECRET_KEY': _transfer_source_key,
+    }
+
 ########
 # Cron #
 ########

openstax/urls.py

@@ -5,6 +5,7 @@
 from wagtail.admin import urls as wagtailadmin_urls
 from wagtailautocomplete.urls.admin import urlpatterns as autocomplete_admin_urls
 from wagtail import urls as wagtail_urls
+from wagtail_transfer import urls as wagtailtransfer_urls
 from wagtail.documents import urls as wagtaildocs_urls
 from accounts import urls as accounts_urls
 
@@ -48,6 +49,8 @@
     path('apps/cms/api/spike/', include(wagtail_urls)),
     path('sitemap.xml', sitemap),
 
+    path('wagtail-transfer/', include(wagtailtransfer_urls)),
+
     # For anything not caught by a more specific rule above, hand over to Wagtail's serving mechanism
     path('', include(wagtail_urls)),
 ]

requirements/base.txt

@@ -33,4 +33,5 @@ vcrpy==7.0.0
 wagtail==7.3.1
 wagtail-autocomplete==0.12.0
 wagtail-modeladmin==2.2.0
+wagtail-transfer==0.11
 whitenoise==6.9.0