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_APPSin your projectslocal.py - generate a
Full AccessAPI 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 |
FAQ
- I lost admin when i registered my admin user.
- add a group called
Administratorsto 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
File details
Details for the file allianceauth-wiki-js-0.0.3.tar.gz.
File metadata
- Download URL: allianceauth-wiki-js-0.0.3.tar.gz
- Upload date:
- Size: 9.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.7.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
863ea0299c095feff05b7b33ccb066b16aaa69b2f3cabfccd037e66305f67230
|
|
| MD5 |
1e20b48928b619271d0976ddbfd0a695
|
|
| BLAKE2b-256 |
70bc5d75b71416e2a5fc3ab2c678402f8b90e74a9226da093994b6f2b317280a
|