allianceauth-mumbletemps


Nameallianceauth-mumbletemps JSON
Version 2.0.1 PyPI version JSON
download
home_page
SummaryMumble Temp Links plugin for Alliance Auth
upload_time2020-06-30 15:12:28
maintainer
docs_urlNone
authorAaronKable
requires_python
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Mumble Temp Links

> ⚠️ This does nothing on it's own you also need to update your authenticator! [To my fork found here](https://gitlab.com/aaronkable/mumble-authenticator). More on that in the setup instructions below!

This [Alliance Auth](https://gitlab.com/allianceauth/allianceauth) module lets you give temp access to your mumble service with ease.

# Usage
A user with the create permission crates a link and copy's it to the people who need access,
TempLink users will be given the group `Guest`, mumble ACL's can be setup to restrict access as required.
The mumble chat command `!kicktemps` will purge the mumble server of all temp users, if they still have a valid Templink they will be able to reconect untill it either expires or is removed from the tool. Only members who have thw `Kick User` permission can use the command.

# Setup
> ⚠️This is assuming you already have configured a fully functioning mumbke service.
## Auth Plugin
1. `pip install allianceauth-mumbletemps`
2. add `'mumbletemps',` to your `INSTALLED_APPS` in the local.py, i recomend it is at the top for menu ordering.
3. run migrations
4. restart auth

## Settings
Setting | Default	 | Description 
 --- | --- | --- 
MUMBLE_TEMPS_FORCE_SSO | True | Setting this to `False` will allow users to auth with the non-sso method
MUMBLE_TEMPS_SSO_PREFIX | "[TEMP]" | Display Name Prefix for an SSO'd temp user in mumble
MUMBLE_TEMPS_LOGIN_PREFIX | "[*TEMP]" | Display Name Prefix for a non-SSO'd temp user in mumble


## Mumble Authenticator
to update your mumble authenticator if you git cloned the original repo we will add my branch as a remote and checkout the updated code.
> ⚠️It is a good idea to backup your `authenticator.ini` file before starting
1. `cd` into the folder you have the authenticator code in.
2. `git status` to confirm it is a git repo and the correct place
3. `git remote add upstream git@gitlab.com:aaronkable/mumble-authenticator.git` to add the remote
4. `git fetch upstream` to grab the updates
5. `git checkout upstream/master` to roll over to my code
6. restart your authenticator with supervisor
> ℹ️ The authenticator.log should show something like 
> `Starting AllianceAuth mumble authenticator V:1.0.0 - TempLinks` 
> if you are on the correct branch and version, if not you may still be running the default auth verssion and will need to investigate why. Users will get propted for passwords when they try to connect with a temp link and you are not running this version. the Authenticator version needs to match this version!

If you did not use the git clone method of installing the authenticator, simply copy the contents of [my fork found here](https://gitlab.com/aaronkable/mumble-authenticator) over the top of your current install, **BE SURE TO BACKUP YOUR `authenticator.ini` BEFORE YOU START!**

## Auth Login Bypass
To enable people to not have to register on auth, ensure you have fully updated `django-esi`
1. edit your projects `urls.py` file:

> if should look something like this, if yours is different only add the parts outlined below:
```python
from django.conf.urls import include, url
from allianceauth import urls

urlpatterns = [ 
    url(r'', include(urls)),
]

handler500 = 'allianceauth.views.Generic500Redirect'
handler404 = 'allianceauth.views.Generic404Redirect'
handler403 = 'allianceauth.views.Generic403Redirect'
handler400 = 'allianceauth.views.Generic400Redirect' 
```
> edit it to add a new import and a new url
```python
from django.conf.urls import include, url
from allianceauth import urls
from mumbletemps.views import link  # *** New Import 

urlpatterns = [
    url(r'^mumbletemps/join/(?P<link_ref>[\w\-]+)/$', link, name='join'),  # *** New URL override BEFORE THE MAIN IMPORT
    url(r'', include(urls)),
]

handler500 = 'allianceauth.views.Generic500Redirect' 
handler404 = 'allianceauth.views.Generic404Redirect'
handler403 = 'allianceauth.views.Generic403Redirect'
handler400 = 'allianceauth.views.Generic400Redirect' 
```
2. restart services and you're done.

# Permissions
Perm | Admin Site	 | Auth Site 
 --- | --- | --- 
mumbletemps.create_new_links | None | Can create and delete Temp Links.

# Preview
## Managemrnt and Creatiom
![image](https://i.imgur.com/Jl2ihH2.png)
## OPTIONAL Login Screen ( Non SSO mode )
![Login](https://i.imgur.com/BIRLFmq.png)
## Templink User View
![Demo](https://i.imgur.com/G86qAb8.png)
            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "allianceauth-mumbletemps",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "AaronKable",
    "author_email": "aaronkable@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/2d/cc/8636fef5e6cae5c26c054043ed642507a2d1ac6448f1090b6fde082924e3/allianceauth-mumbletemps-2.0.1.tar.gz",
    "platform": "",
    "description": "# Mumble Temp Links\n\n> \u26a0\ufe0f This does nothing on it's own you also need to update your authenticator! [To my fork found here](https://gitlab.com/aaronkable/mumble-authenticator). More on that in the setup instructions below!\n\nThis [Alliance Auth](https://gitlab.com/allianceauth/allianceauth) module lets you give temp access to your mumble service with ease.\n\n# Usage\nA user with the create permission crates a link and copy's it to the people who need access,\nTempLink users will be given the group `Guest`, mumble ACL's can be setup to restrict access as required.\nThe mumble chat command `!kicktemps` will purge the mumble server of all temp users, if they still have a valid Templink they will be able to reconect untill it either expires or is removed from the tool. Only members who have thw `Kick User` permission can use the command.\n\n# Setup\n> \u26a0\ufe0fThis is assuming you already have configured a fully functioning mumbke service.\n## Auth Plugin\n1. `pip install allianceauth-mumbletemps`\n2. add `'mumbletemps',` to your `INSTALLED_APPS` in the local.py, i recomend it is at the top for menu ordering.\n3. run migrations\n4. restart auth\n\n## Settings\nSetting | Default\t | Description \n --- | --- | --- \nMUMBLE_TEMPS_FORCE_SSO | True | Setting this to `False` will allow users to auth with the non-sso method\nMUMBLE_TEMPS_SSO_PREFIX | \"[TEMP]\" | Display Name Prefix for an SSO'd temp user in mumble\nMUMBLE_TEMPS_LOGIN_PREFIX | \"[*TEMP]\" | Display Name Prefix for a non-SSO'd temp user in mumble\n\n\n## Mumble Authenticator\nto update your mumble authenticator if you git cloned the original repo we will add my branch as a remote and checkout the updated code.\n> \u26a0\ufe0fIt is a good idea to backup your `authenticator.ini` file before starting\n1. `cd` into the folder you have the authenticator code in.\n2. `git status` to confirm it is a git repo and the correct place\n3. `git remote add upstream git@gitlab.com:aaronkable/mumble-authenticator.git` to add the remote\n4. `git fetch upstream` to grab the updates\n5. `git checkout upstream/master` to roll over to my code\n6. restart your authenticator with supervisor\n> \u2139\ufe0f The authenticator.log should show something like \n> `Starting AllianceAuth mumble authenticator V:1.0.0 - TempLinks` \n> if you are on the correct branch and version, if not you may still be running the default auth verssion and will need to investigate why. Users will get propted for passwords when they try to connect with a temp link and you are not running this version. the Authenticator version needs to match this version!\n\nIf you did not use the git clone method of installing the authenticator, simply copy the contents of [my fork found here](https://gitlab.com/aaronkable/mumble-authenticator) over the top of your current install, **BE SURE TO BACKUP YOUR `authenticator.ini` BEFORE YOU START!**\n\n## Auth Login Bypass\nTo enable people to not have to register on auth, ensure you have fully updated `django-esi`\n1. edit your projects `urls.py` file:\n\n> if should look something like this, if yours is different only add the parts outlined below:\n```python\nfrom django.conf.urls import include, url\nfrom allianceauth import urls\n\nurlpatterns = [ \n    url(r'', include(urls)),\n]\n\nhandler500 = 'allianceauth.views.Generic500Redirect'\nhandler404 = 'allianceauth.views.Generic404Redirect'\nhandler403 = 'allianceauth.views.Generic403Redirect'\nhandler400 = 'allianceauth.views.Generic400Redirect' \n```\n> edit it to add a new import and a new url\n```python\nfrom django.conf.urls import include, url\nfrom allianceauth import urls\nfrom mumbletemps.views import link  # *** New Import \n\nurlpatterns = [\n    url(r'^mumbletemps/join/(?P<link_ref>[\\w\\-]+)/$', link, name='join'),  # *** New URL override BEFORE THE MAIN IMPORT\n    url(r'', include(urls)),\n]\n\nhandler500 = 'allianceauth.views.Generic500Redirect' \nhandler404 = 'allianceauth.views.Generic404Redirect'\nhandler403 = 'allianceauth.views.Generic403Redirect'\nhandler400 = 'allianceauth.views.Generic400Redirect' \n```\n2. restart services and you're done.\n\n# Permissions\nPerm | Admin Site\t | Auth Site \n --- | --- | --- \nmumbletemps.create_new_links | None | Can create and delete Temp Links.\n\n# Preview\n## Managemrnt and Creatiom\n![image](https://i.imgur.com/Jl2ihH2.png)\n## OPTIONAL Login Screen ( Non SSO mode )\n![Login](https://i.imgur.com/BIRLFmq.png)\n## Templink User View\n![Demo](https://i.imgur.com/G86qAb8.png)",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Mumble Temp Links plugin for Alliance Auth",
    "version": "2.0.1",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "1af4000ddd6ce4d652dd222e7fc44e08",
                "sha256": "064ebdf3e30a18ac8f65fc70dd7f61538b52455daf683bf04ff66b8b60335ae7"
            },
            "downloads": -1,
            "filename": "allianceauth-mumbletemps-2.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "1af4000ddd6ce4d652dd222e7fc44e08",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 11814,
            "upload_time": "2020-06-30T15:12:28",
            "upload_time_iso_8601": "2020-06-30T15:12:28.966819Z",
            "url": "https://files.pythonhosted.org/packages/2d/cc/8636fef5e6cae5c26c054043ed642507a2d1ac6448f1090b6fde082924e3/allianceauth-mumbletemps-2.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-06-30 15:12:28",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "allianceauth-mumbletemps"
}
        
Elapsed time: 0.11289s