# Discord Multiverse
Service module for managing an unlimited number of discord servers from a single auth instance. It can run side by side with the core auth discord service, or completely standalone.
Most of the code is borrowed from Alliance Auth's core Discord Service Module[link] and re-purposed to be guild agnostic.
Active Devs:
- [AaronKable](https://github.com/pvyParts)
```diff
- THIS APPLICATION IS NOT PRODUCTION READY
```
MID PRIO:
- TODO: Check the performance with massive servers/counts...
- TODO: ensure no cache conflicts
- TODO: Instructions and documentation
- TODO: Maybe custom client/secrets at a server level?
HIGH PRIO!
- TODO: Check AuthBot to see what it does.
- TODO: Check/update all members on change of server model.
### Installation
1. pip install `package`
2. Add `'aadiscordmultiverse',` to your `INSTALLED_APPS` in your projects `local.py`
3. Run migrations, collectstatic and restart auth.
4. Setup your permissions as documented below
### Access Control and Server Permissions
- First and foremost to access **ANY** server a user must have this permission;
- `aadiscordmultiverse | discord managed server | Can access the Discord Multiverse services`
- Access control to each server is managed by the Server Model
- You can grant access by adding one of the following to the managed server in admin.
- User State
- User Groups
- Main Characters Faction
- Main Characters Alliance
- Main Characters Corporation
- Main Character
### Adding a Guild to Auth
1. Add a new `DISCORD MANAGED SERVER` in admin
2. Set the guild id to match your new server
3. set any access control settings you need
4. Set the ignored groups for the server. These groups wll not be synced to this discord server.
5. Click Save
6. Goto Services in the main auth site
7. Click "Link Discord" on the new server and add your auth bot to the correct server.
8. People can now join as required
Raw data
{
"_id": null,
"home_page": "https://github.com/Solar-Helix-Independent-Transport/allianceauth-discord-multiverse",
"name": "allianceauth-discord-multiverse",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "AaronKable",
"author_email": "aaronkable@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/10/e8/e442560f8ff4cde8d3f58e512216cc8db86ca1ed75a38bc43275c93fdc76/allianceauth-discord-multiverse-0.0.1a3.tar.gz",
"platform": null,
"description": "# Discord Multiverse\n\nService module for managing an unlimited number of discord servers from a single auth instance. It can run side by side with the core auth discord service, or completely standalone.\n\nMost of the code is borrowed from Alliance Auth's core Discord Service Module[link] and re-purposed to be guild agnostic.\n\nActive Devs:\n\n- [AaronKable](https://github.com/pvyParts)\n\n```diff\n- THIS APPLICATION IS NOT PRODUCTION READY\n```\n\nMID PRIO:\n\n- TODO: Check the performance with massive servers/counts...\n- TODO: ensure no cache conflicts\n- TODO: Instructions and documentation\n- TODO: Maybe custom client/secrets at a server level?\n\nHIGH PRIO!\n\n- TODO: Check AuthBot to see what it does.\n- TODO: Check/update all members on change of server model.\n\n### Installation\n\n1. pip install `package`\n2. Add `'aadiscordmultiverse',` to your `INSTALLED_APPS` in your projects `local.py`\n3. Run migrations, collectstatic and restart auth.\n4. Setup your permissions as documented below\n\n### Access Control and Server Permissions\n\n- First and foremost to access **ANY** server a user must have this permission;\n - `aadiscordmultiverse | discord managed server | Can access the Discord Multiverse services`\n- Access control to each server is managed by the Server Model\n - You can grant access by adding one of the following to the managed server in admin.\n - User State\n - User Groups\n - Main Characters Faction\n - Main Characters Alliance\n - Main Characters Corporation\n - Main Character\n\n### Adding a Guild to Auth\n\n1. Add a new `DISCORD MANAGED SERVER` in admin\n2. Set the guild id to match your new server\n3. set any access control settings you need\n4. Set the ignored groups for the server. These groups wll not be synced to this discord server.\n5. Click Save\n6. Goto Services in the main auth site\n7. Click \"Link Discord\" on the new server and add your auth bot to the correct server.\n8. People can now join as required\n\n\n",
"bugtrack_url": null,
"license": "GNU General Public License v3 (GPLv3)",
"summary": "Alliance Auth Plugin",
"version": "0.0.1a3",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "10e8e442560f8ff4cde8d3f58e512216cc8db86ca1ed75a38bc43275c93fdc76",
"md5": "02b953649c0180a932823d2c2ec71457",
"sha256": "4d8c26d2cf4ae190c30d9d330c594cf25c82ca1da804cab6e2e05b302144c4d3"
},
"downloads": -1,
"filename": "allianceauth-discord-multiverse-0.0.1a3.tar.gz",
"has_sig": false,
"md5_digest": "02b953649c0180a932823d2c2ec71457",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 43302,
"upload_time": "2023-02-06T08:24:37",
"upload_time_iso_8601": "2023-02-06T08:24:37.381820Z",
"url": "https://files.pythonhosted.org/packages/10/e8/e442560f8ff4cde8d3f58e512216cc8db86ca1ed75a38bc43275c93fdc76/allianceauth-discord-multiverse-0.0.1a3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-06 08:24:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Solar-Helix-Independent-Transport",
"github_project": "allianceauth-discord-multiverse",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "allianceauth-discord-multiverse"
}
JSON
