Simple User and group management for Wiki JS as a service of AllianceAuth
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 |
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
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.1.0.tar.gz
(24.1 kB
view hashes)
Built Distribution
Close
Hashes for allianceauth_wiki_js-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d0638845bae9b41246dca2edf27901b790ce6dc172f81c4edd253d9c7076c7c9 |
|
MD5 | 3543853fe45e0db699930bef5c472c7e |
|
BLAKE2b-256 | 58a975024b0ed32c2251c15d84e5fee6e5d10d9f012d5e63156ae26604f652cf |
Close
Hashes for allianceauth_wiki_js-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 301fd780b199d8d3cb3ba954325ab9172b710cac27fe85237670d790abc73903 |
|
MD5 | 910bde4951e29e8ea4f3d4aa8f8ea9e4 |
|
BLAKE2b-256 | cffcb5d32b05a1df207aaf9ebb48a908b49e8e28a965a3db37dc58f22dfd3e2a |