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 |
| WIKIJS_AADISCORDBOT_INTEGRATION | True | Enables an AADiscordbot cog with the ability to search the wiki |
If you have issues with auth not being able to access the wiki due to SSL/redirection or similar. ( Cloudlfair can cause issues)
| Setting | default | Description |
|---|---|---|
| WIKIJS_API_URL | WIKIJS_URL | URL Overide for API access |
add this setting to your local py with a direct link to the wiki
# if auth is on the same box as wiki
WIKIJS_API_URL = "http://localhost:3000"
# if auth is on a different machine you could use the public ip adress of that machine.
WIKIJS_API_URL = "http://10.0.0.150:3000"
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.
1 maintainer
Metadata
1 maintainer
Release files for allianceauth-wiki-js 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| allianceauth_wiki_js-0.1.1.tar.gz | 24.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| allianceauth_wiki_js-0.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 47.8 kB
Release files / allianceauth_wiki_js-0.1.1.tar.gz
| Download URL | allianceauth_wiki_js-0.1.1.tar.gz |
|---|---|
| Size | 24.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b405d2767798019d13152c4642283a0ae0557099a2dc4853859e89ec167252ab
|
|
BLAKE2b-256 checksum How to use checksums |
a130f863268c377d7b32419b06839fddbee140248d2d78ff2f5195e5c54e3001
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.9
|
Release files / allianceauth_wiki_js-0.1.1-py3-none-any.whl
| Download URL | allianceauth_wiki_js-0.1.1-py3-none-any.whl |
|---|---|
| Size | 23.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
28e4c889f248e7d20e27905b209f73f608681142ffeafb981be427dbe305c009
|
|
BLAKE2b-256 checksum How to use checksums |
a41489bdeb3c5c07a29c5cd32b0c7a348db86d32046bf7f5b0e4e69cd8266dd4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.9
|
