| Name | allianceauth-wiki-js JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Simple User and group management for Wiki JS as a service of AllianceAuth |
| upload_time | 2024-08-31 14:10:32 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
allianceauth
eveonline
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# 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 |
| 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
```python
# 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "allianceauth-wiki-js",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "allianceauth, eveonline",
"author": null,
"author_email": "AaronKable <aaronkable@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a1/30/f863268c377d7b32419b06839fddbee140248d2d78ff2f5195e5c54e3001/allianceauth_wiki_js-0.1.1.tar.gz",
"platform": null,
"description": "# Wiki-JS service\n\nSimple User and group management for [Wiki JS](https://wiki.js.org/) as a service of AllianceAuth\n\n## Setup\n\n0. install and setup your Wiki.js instance [from the Wiki Docs](https://docs.requarks.io/)\n1. activate venv\n2. `pip install -U allianceauth-wiki-js`\n3. add `'wikijs',` to your `INSTALLED_APPS` in your projects `local.py`\n4. generate a `Full Access` API key iun the wiki with maximum expiration be sure to copy it as the key wont be shown again.\n5. add the settings ( outlined below ) to your `local.py`\n6. run migrations and restart auth\n7. setup permissions ( outlined below )\n\n## Permissions\n\n| Perm | Codename | Admin | Frontend |\n| ----------------------------- | ------------- | ------------ | ------------------------------- |\n| Can access the WikiJS service | access_wikijs | - | Gives access to Wiki.js service |\n| Can add wiki js | - | Admin add | - |\n| Can change wiki js | - | Admin Edit | - |\n| Can delete wiki js | - | Admin Delete | - |\n| Can view wiki js | - | Admin View | - |\n\n## Settings\n\n| Setting | default | Description |\n| ------------------------------- | ------- | --------------------------------------------------------------- |\n| WIKIJS_API_KEY | \"\" | your global API key from the wiki admin section |\n| WIKIJS_URL | \"\" | You Wiki's base URL |\n| WIKIJS_AADISCORDBOT_INTEGRATION | True | Enables an AADiscordbot cog with the ability to search the wiki |\n\nIf you have issues with auth not being able to access the wiki due to SSL/redirection or similar. ( Cloudlfair can cause issues)\n\n| Setting | default | Description |\n| -------------- | ---------- | -------------------------- |\n| WIKIJS_API_URL | WIKIJS_URL | URL Overide for API access |\n\nadd this setting to your local py with a direct link to the wiki\n\n```python\n# if auth is on the same box as wiki\nWIKIJS_API_URL = \"http://localhost:3000\"\n\n# if auth is on a different machine you could use the public ip adress of that machine.\nWIKIJS_API_URL = \"http://10.0.0.150:3000\"\n```\n\n## FAQ\n\n- I lost admin when i registered my admin user.\n - add a group called `Administrators` to your auth instance and give it to anyone who needs admin on the wiki.\n- I cant lock down my wiki to registered members only.\n - i had to delete a row from the database manually to remove the guest roles permissions. Ask in the AA discord.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Simple User and group management for Wiki JS as a service of AllianceAuth",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/Solar-Helix-Independent-Transport/allianceauth-wiki-js",
"Source": "https://github.com/Solar-Helix-Independent-Transport/allianceauth-wiki-js",
"Tracker": "https://github.com/Solar-Helix-Independent-Transport/allianceauth-wiki-js/issues"
},
"split_keywords": [
"allianceauth",
" eveonline"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a41489bdeb3c5c07a29c5cd32b0c7a348db86d32046bf7f5b0e4e69cd8266dd4",
"md5": "cf873937516fa217a7eefc28490918ec",
"sha256": "28e4c889f248e7d20e27905b209f73f608681142ffeafb981be427dbe305c009"
},
"downloads": -1,
"filename": "allianceauth_wiki_js-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cf873937516fa217a7eefc28490918ec",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 23283,
"upload_time": "2024-08-31T14:10:31",
"upload_time_iso_8601": "2024-08-31T14:10:31.805612Z",
"url": "https://files.pythonhosted.org/packages/a4/14/89bdeb3c5c07a29c5cd32b0c7a348db86d32046bf7f5b0e4e69cd8266dd4/allianceauth_wiki_js-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a130f863268c377d7b32419b06839fddbee140248d2d78ff2f5195e5c54e3001",
"md5": "0894554f7490b15887e6448d684f6afd",
"sha256": "b405d2767798019d13152c4642283a0ae0557099a2dc4853859e89ec167252ab"
},
"downloads": -1,
"filename": "allianceauth_wiki_js-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "0894554f7490b15887e6448d684f6afd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 24514,
"upload_time": "2024-08-31T14:10:32",
"upload_time_iso_8601": "2024-08-31T14:10:32.962861Z",
"url": "https://files.pythonhosted.org/packages/a1/30/f863268c377d7b32419b06839fddbee140248d2d78ff2f5195e5c54e3001/allianceauth_wiki_js-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-31 14:10:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Solar-Helix-Independent-Transport",
"github_project": "allianceauth-wiki-js",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "allianceauth-wiki-js"
}
