Welcome to wagtail-tenants documentation
wagtail-tenants is an app for wagtail cms to provide multi-tenancy. My goal was to get a root wagtail instrance and use the beautiful wagtail admin to host multiple wagtail instances without touching the server directly.
It should be as easy as create a website within a running wagtail instance.
I came up with different approaches and finally, after talking to a lot of others I decided to go the postgres schema path. You can find a good documentation here and here.
Feel free to contribute to keep this alive. I am not the best at that 🤞
pip install wagtail-tenants
Add “wagtail_tenants” to your INSTALLED_APPS setting like this:
SHARED_APPS = ( 'wagtail_tenants.customers' 'wagtail_tenants', 'wagtail.contrib.forms', ... "wagtail_tenants.users", "wagtail.users", ... ) TENANT_APPS = ( 'wagtail_tenants', "django.contrib.contenttypes", ... # rest of the wagtail apps ... "wagtail_tenants.users", "wagtail.users", ... ) INSTALLED_APPS = list(SHARED_APPS) + [ app for app in TENANT_APPS if app not in SHARED_APPS ]
Include the the tenants middleware at the beginning of your middlewares:
MIDDLEWARE = [ "wagtail_tenants.middleware.main.WagtailTenantMainMiddleware", ... ]
Define the Tenant model Constants (and also set the default auto field if not already done):
AUTH_USER_MODEL = 'wagtail_tenants.User' TENANT_MODEL = "customers.Client" TENANT_DOMAIN_MODEL = "customers.Domain" DEFAULT_AUTO_FIELD='django.db.models.AutoField'
Set the Database Router to work with the tenants:
DATABASE_ROUTERS = ("wagtail_tenants.routers.WagtailTenantSyncRouter",)
Set the authentication backend to fit to our Tenant model.
AUTHENTICATION_BACKENDS = [ 'wagtail_tenants.backends.TenantBackend', ]
Run the migrations with
./manage.py migrate_schemas --shared
Create a public schema with
Create a superuser for the public tenant
Start the Server and have fun
You are able to create tenants within the admin of your public wagtailsite. If you want to log into a tenant you need at least one superuser for the tenant. You can use
./manage.py create_tenant_superuserfor that.
This project is under active development.