Skip to main content

Wiki plugin app for Alliance Auth.

Project description

evewiki

Wiki plugin for AllianceAuth to curate content.

Documentation

Features

  • Collaborative editing for editors
  • Create and organise pages in a hierarchical structure using slugs
  • Supports markdown with both rich and raw editing modes
  • Version History
  • Event logging
  • Restrict content by user's groups and/or states
  • Publish public pages

Installation

Step 1 - Pre_Requisites

Evewiki is an App for Alliance Auth, Please make sure you have this installed. Evewiki is not a standalone Django Application

Step 2 - Install app

pip install evewiki

Step 3 - Configure Auth settings

Configure your Auth settings (local.py) as follows:

  • Add evewiki to INSTALLED_APPS in local.py
INSTALLED_APPS += [
	'evewiki',
...
  • Optional: Add evewiki to APPS_WITH_PUBLIC_VIEWS in local.py To enable public pages
APPS_WITH_PUBLIC_VIEWS = [
    'evewiki',
]

Step 4 - Maintain Alliance Auth

  • Run migrations python manage.py migrate
  • Gather your staticfiles python manage.py collectstatic
  • Restart Alliance Auth

Run migrations python manage.py migrate Restart Alliance Auth

Step 5

In AA admin site add Permissions

  • evewiki | general | Can access this app
  • evewiki | general | Can edit this app to the desired States / Groups

i.e. you may wish to create a wiki_editors group to restrict the Can edit this app controls.

Permissions

Users need to have at least basic_access interactions with the application

Name Description
basic_access Basic access to load content
editor_access Grant the necessary controls and access to edit content

Settings

List of settings that can be modified for the application You can alter them by adding a record to the Settings section/table in the evewiki section of the Admin site

Name Description Default
hierarchy_max_display_depth Limit the depth of the tree for the hierarchy on the main display 10
max_versions No one has infinite disk space, a sensible limit which can be modified to clear down the history 1000

Screenshots

View Mode

View Mode

Edit Mode

Edit Mode

Raw Mode

Raw Mode

Public badge

Public

Page Details

Page Details

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

evewiki-1.0.3.tar.gz (130.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

evewiki-1.0.3-py3-none-any.whl (138.3 kB view details)

Uploaded Python 3

File details

Details for the file evewiki-1.0.3.tar.gz.

File metadata

  • Download URL: evewiki-1.0.3.tar.gz
  • Upload date:
  • Size: 130.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for evewiki-1.0.3.tar.gz
Algorithm Hash digest
SHA256 2f2219c0aa670b37883efd13403990440bb259db29bde4b7e11c5fd70e6d28f6
MD5 4f9844053da53d5af474fee1310857dd
BLAKE2b-256 61f5b844222c1e1e9ce44d841982c8c01425ff3ed0ba8c1436588cd2b86a4078

See more details on using hashes here.

File details

Details for the file evewiki-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: evewiki-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 138.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for evewiki-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 403346ea6e27261c78b466dc291e81c503159c4b5b674d24a3ed9b3bacefa992
MD5 fc6af3a8dfd2e21e7268947f82bc3381
BLAKE2b-256 d5611fcddfa66b9bc163a5a4c0cbdf9a090703f9d7e15462b26b35ba04a725c8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page