Docs

Documentation

Collaborative staff wiki for Django Admin — edit in the browser, search with Postgres. PyPI package : django-admin-wiki.

1. On-premise install

Requirements : Python ≥ 3.10, Django ≥ 4.2 and < 6. PostgreSQL recommended for full-text search.

pip install django-admin-wiki

# settings.py
INSTALLED_APPS = [
    ...,
    "django.contrib.postgres",  # if using Postgres FTS
    "django_summernote",
    "django_admin_wiki",
]

MEDIA_URL = "/media/"
MEDIA_ROOT = BASE_DIR / "media"

DJANGO_ADMIN_WIKI = {
    "STORAGE": "local",
    "SEARCH_BACKEND": "postgres",  # or "fallback"
    "SEARCH_CONFIG": "english",
    "EDITOR": "summernote",
    "URL_PREFIX": "wiki/",
}

# urls.py
path("summernote/", include("django_summernote.urls")),
path("wiki/", include("django_admin_wiki.urls")),

python manage.py migrate
python manage.py setup_wiki_groups
python manage.py runserver

Then open /wiki/. is_staff alone does not grant wiki access.

2. Access rights

URL	Who can enter
`/admin/`	Django Admin → `is_staff`
`/wiki/`	Wiki readers or Wiki editors groups

Wiki readers — open, search, view
Wiki editors — create / edit / upload media
Superusers always have full wiki access

Assign users in Django Admin → Users (or Groups).

3. Premium cloud

Subscribe at django-admin-wiki.enprod.fr. The account dashboard provides write and read-only API keys. No wiki tables are created in the host database.

INSTALLED_APPS = [..., "django_summernote", "django_admin_wiki"]

MIGRATION_MODULES = {"django_admin_wiki": None}

DJANGO_ADMIN_WIKI = {
    "STORAGE": "cloud",
    "CLOUD_API_URL": "https://django-admin-wiki.enprod.fr",
    "CLOUD_API_KEY": "daw_live_...",        # write (editors)
    "CLOUD_API_KEY_READ": "daw_live_...",   # read-only (readers)
    "EDITOR": "summernote",
}

Rights still follow the logged-in user of your Django project. The Premium account only manages billing and API keys.

4. Media & editor

Images are uploaded as files (no base64 in the database). Default : local filesystem under DOCS_DIR/uploads/ via POST /wiki/media/upload/.

Optional S3 (on-premise) :

pip install "django-admin-wiki[s3]"
# MEDIA_BACKEND = "django" + STORAGES["default"] = S3

Alternative editor : EDITOR="textarea" (or a custom widget).

5. MkDocs import

Local mode only :

python manage.py import_mkdocs
python manage.py refresh_wiki_search_vectors  # Postgres