Skip to content

Latest commit

 

History

History
35 lines (29 loc) · 1.4 KB

File metadata and controls

35 lines (29 loc) · 1.4 KB

Wiki-JS service

Simple User and group management for Wiki JS as a service of AllianceAuth

Setup

  1. install and setup your Wiki.js instance from the Wiki Docs
  2. activate venv
  3. pip install -U allianceauth-wiki-js
  4. add 'wikijs', to your INSTALLED_APPS in your projects local.py
  5. generate a Full Access API key iun the wiki with maximum expiration be sure to copy it as the key wont be shown again.
  6. add the settings ( outlined below ) to your local.py
  7. run migrations and restart auth
  8. setup permissions ( outlined below )

Permissions

Perm Codename Admin Frontend
Can access the WikiJS service access_wikijs - Gives access to Wiki.js service
Can add wiki js - Admin add -
Can change wiki js - Admin Edit -
Can delete wiki js - Admin Delete -
Can view wiki js - Admin View -

Settings

Setting default Description
WIKIJS_API_KEY "" your global API key from the wiki admin section
WIKIJS_URL "" You Wiki's base URL

FAQ

  • I lost admin when i registered my admin user.
    • add a group called Administrators to your auth instance and give it to anyone who needs admin on the wiki.
  • I cant lock down my wiki to registered members only.
    • i had to delete a row from the database manually to remove the guest roles permissions. Ask in the AA discord.