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

Settings

If you have issues with auth not being able to access the wiki due to SSL/redirection or similar. ( Cloudlfair can cause issues)

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.
• 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.

No reviews yet...

Python Requirements

• allianceauth<5,>=3
• graphqlclient
• allianceauth-discordbot>=3.8; extra == "discordbot"

Required Python packages to be installed and other Python requirement.

App Dependencies

Required apps:

• allianceauth-discordbot

Used by apps:

-

Dependencies to other apps registered in this app directory.

Classifiers

• Environment :: Web Environment
• Framework :: Celery
• Framework :: Django
• Framework :: Django :: 4.0
• Framework :: Django :: 4.2
• Intended Audience :: Developers
• License :: OSI Approved :: GNU General Public License v3 (GPLv3)
• Operating System :: OS Independent
• Programming Language :: Python
• Programming Language :: Python :: 3 :: Only
• Programming Language :: Python :: 3.10
• Programming Language :: Python :: 3.11
• Programming Language :: Python :: 3.12
• Programming Language :: Python :: 3.8
• Programming Language :: Python :: 3.9
• Programming Language :: Python :: Implementation :: CPython
• Topic :: Internet :: WWW/HTTP
• Topic :: Internet :: WWW/HTTP :: Dynamic Content