Browse Apps

evewiki

Wiki plugin app for Alliance Auth.


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

No reviews yet...

Python Requirements

  • allianceauth>=3

Required Python packages to be installed and other Python requirement.

App Dependencies


Required apps:

    -


Used by apps:

    -

Dependencies to other apps registered in this app directory.

Classifiers

  • Environment :: Web Environment
  • Framework :: Django
  • Framework :: Django :: 4.0
  • Framework :: Django :: 4.2
  • Intended Audience :: Developers
  • License :: OSI Approved :: MIT License
  • Operating System :: OS Independent
  • Programming Language :: Python
  • Programming Language :: Python :: 3.10
  • Programming Language :: Python :: 3.11
  • Programming Language :: Python :: 3.8
  • Programming Language :: Python :: 3.9
  • Topic :: Internet :: WWW/HTTP
  • Topic :: Internet :: WWW/HTTP :: Dynamic Content

Version

0.0.1

License

MIT License

Homepage

  https://gitlab.com/cunningdesigns/evewiki

PyPI

  https://pypi.org/project/evewiki/

Last updated

4 months, 3 weeks ago

First published

5 months ago

Category

Plugin Apps

Rating

-

Authors

Ryan Cunning

Maintainers

Celestial Necromancer Celestial Necromancer

Please login to see more options.