Metadata-Version: 2.1
Name: allianceauth-wiki-js
Version: 0.0.5
Summary: Alliance Auth Service module for Wiki JS
Home-page: https://github.com/pvyParts/allianceauth-wiki-js
Author: AaronKable
Author-email: aaronkable@gmail.com
License: MIT
Description: # Wiki-JS service
        
        Simple User and group management for [Wiki JS](https://wiki.js.org/) as a service of AllianceAuth 
        
        ## Setup
        0. install and setup your Wiki.js instance [from the Wiki Docs](https://docs.requarks.io/)
        1. activate venv
        2. `pip install -U allianceauth-wiki-js`
        3. add `'wikijs',` to your `INSTALLED_APPS` in your projects `local.py`
        4. generate a `Full Access` API key iun the wiki with maximum expiration be sure to copy it as the key wont be shown again.
        5. add the settings ( outlined below ) to your `local.py`
        6. run migrations and restart auth
        7. 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 `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.
        
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Description-Content-Type: text/markdown
