Alliance Auth Service module for Wiki JS
Project description
Wiki-JS service
Simple User and group management for Wiki JS as a service of AllianceAuth
Setup
- install and setup your Wiki.js instance from the Wiki Docs
- activate venv
pip install -U allianceauth-wiki-js
- add
'wikijs',
to yourINSTALLED_APPS
in your projectslocal.py
- generate a
Full Access
API key iun the wiki with maximum expiration be sure to copy it as the key wont be shown again. - add the settings ( outlined below ) to your
local.py
- run migrations and restart auth
- 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 |
WIKIJS_AADISCORDBOT_INTEGRATION | True | Enables an AADiscordbot cog with the ability to search the wiki |
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.
- add a group called
- 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
allianceauth-wiki-js-0.0.6.tar.gz
(17.4 kB
view hashes)
Close
Hashes for allianceauth-wiki-js-0.0.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7e37bf77b1b0f659d58c3f8b6c880357c95812beac607eff5ede44f0fff2561 |
|
MD5 | 18b5be2344b4d0e2b2df96157135185e |
|
BLAKE2b-256 | 6c4fb07486661785446b2b13b17c0cc71b27dbccd74444255f9c39eb4acbe341 |