allianceauth-mumbletemps


Nameallianceauth-mumbletemps JSON
Version 3.0.2 PyPI version JSON
download
home_pageNone
SummaryMumble Temp Links plugin for Alliance Auth
upload_time2024-07-05 10:30:26
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT License Copyright (c) 2019 Aaron Kable Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords allianceauth eveonline mumble
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Mumble Temp Links<a name="mumble-temp-links"></a>

> \[!IMPORTANT\]
>
> This does nothing on its 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.

______________________________________________________________________

<!-- mdformat-toc start --slug=github --maxlevel=6 --minlevel=2 -->

- [Usage](#usage)
- [Setup](#setup)
  - [Alliance Auth Plugin](#alliance-auth-plugin)
    - [Step 1: Install the Package](#step-1-install-the-package)
    - [Step 2: Configure Alliance Auth](#step-2-configure-alliance-auth)
    - [Step 3: Finalizing the Installation](#step-3-finalizing-the-installation)
  - [Mumble Authenticator](#mumble-authenticator)
  - [Settings](#settings)
  - [Restart services and you're done.](#restart-services-and-youre-done)
  - [Permissions](#permissions)
- [Preview](#preview)
  - [Management and Creation](#management-and-creation)
  - [OPTIONAL Login Screen (Non SSO mode)](#optional-login-screen-non-sso-mode)
  - [Templink User View](#templink-user-view)

<!-- mdformat-toc end -->

______________________________________________________________________

## Usage<a name="usage"></a>

A user with the `create` permission creates a link and copies 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 reconnect until it either expires or is removed from the tool. Only members who have the `Kick User` permission can use the command.

## Setup<a name="setup"></a>

> \[!NOTE\]
>
> ️This is assuming you already have configured a fully functioning mumble service.

### Alliance Auth Plugin<a name="alliance-auth-plugin"></a>

#### Step 1: Install the Package<a name="step-1-install-the-package"></a>

Make sure you're in the virtual environment (venv) of your Alliance Auth installation. Then install the latest release directly from PyPi.

```shell
pip install allianceauth-mumbletemps
```

#### Step 2: Configure Alliance Auth<a name="step-2-configure-alliance-auth"></a>

You need to add `'mumbletemps',` to your `INSTALLED_APPS` and `APPS_WITH_PUBLIC_VIEWS` in the `local.py` file of your Alliance Auth installation.

This is fairly simple, configure your AA settings (`local.py`) as follows:

```python
INSTALLED_APPS += [
    # Your other apps are here as well
    "mumbletemps",
]

APPS_WITH_PUBLIC_VIEWS += [
    # Other apps with public views might live here
    "mumbletemps",
]

CELERYBEAT_SCHEDULE["mumbletemps_tidy_up_temp_links"] = {
    "task": "mumbletemps.tasks.tidy_up_temp_links",
    "schedule": crontab(minute="*/5"),
}
```

> \[!NOTE\]
>
> If you don't have a list for `APPS_WITH_PUBLIC_VIEWS` yet, then add the whole block
> from here. This feature has been added in Alliance Auth v3.6.0, so you might not yet
> have this list in your `local.py`.

#### Step 3: Finalizing the Installation<a name="step-3-finalizing-the-installation"></a>

Run static files collection and migrations.

```shell
python manage.py collectstatic --noinput
python manage.py migrate
```

### Mumble Authenticator<a name="mumble-authenticator"></a>

To update your mumble authenticator if you git cloned the original repo, we will add my branch as a remote and check out the updated code.

> \[!IMPORTANT\]
>
> ️It is a good idea to back up your `authenticator.ini` file before starting.

1. `cd` into the folder you have the authenticator code in.
1. `git status` to confirm it is a git repo, and the correct place.
1. `git remote add upstream git@gitlab.com:aaronkable/mumble-authenticator.git` to add the remote.
1. `git fetch upstream` to grab the updates.
1. `git checkout upstream/master` to roll over to my code.
1. Restart your authenticator with supervisor.

> \[!NOTE\]
>
> 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 version and will need to investigate why. Users will get prompted 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,
copy the contents of [my forkfound here](https://gitlab.com/aaronkable/mumble-authenticator)
on top of your current installation.

### Settings<a name="settings"></a>

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

### Restart services and you're done.<a name="restart-services-and-youre-done"></a>

Restart your Alliance Auth instance to apply the changes.

```shell
sudo systemctl restart supervisor.service
```

### Permissions<a name="permissions"></a>

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

## Preview<a name="preview"></a>

### Management and Creation<a name="management-and-creation"></a>

![image](https://i.imgur.com/Jl2ihH2.png)

### OPTIONAL Login Screen (Non SSO mode)<a name="optional-login-screen-non-sso-mode"></a>

![Login](https://i.imgur.com/BIRLFmq.png)

### Templink User View<a name="templink-user-view"></a>

![Demo](https://i.imgur.com/G86qAb8.png)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "allianceauth-mumbletemps",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "allianceauth, eveonline, mumble",
    "author": null,
    "author_email": "Aaron Kable <aaronkable@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/25/41/a7b68e20442ef5f9a448965b5090ecb347e3f939c20e23f7dc52894d6adf/allianceauth_mumbletemps-3.0.2.tar.gz",
    "platform": null,
    "description": "# Mumble Temp Links<a name=\"mumble-temp-links\"></a>\n\n> \\[!IMPORTANT\\]\n>\n> This does nothing on its own you also need to update your authenticator [to my\n> fork found here](https://gitlab.com/aaronkable/mumble-authenticator).\n>\n> 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______________________________________________________________________\n\n<!-- mdformat-toc start --slug=github --maxlevel=6 --minlevel=2 -->\n\n- [Usage](#usage)\n- [Setup](#setup)\n  - [Alliance Auth Plugin](#alliance-auth-plugin)\n    - [Step 1: Install the Package](#step-1-install-the-package)\n    - [Step 2: Configure Alliance Auth](#step-2-configure-alliance-auth)\n    - [Step 3: Finalizing the Installation](#step-3-finalizing-the-installation)\n  - [Mumble Authenticator](#mumble-authenticator)\n  - [Settings](#settings)\n  - [Restart services and you're done.](#restart-services-and-youre-done)\n  - [Permissions](#permissions)\n- [Preview](#preview)\n  - [Management and Creation](#management-and-creation)\n  - [OPTIONAL Login Screen (Non SSO mode)](#optional-login-screen-non-sso-mode)\n  - [Templink User View](#templink-user-view)\n\n<!-- mdformat-toc end -->\n\n______________________________________________________________________\n\n## Usage<a name=\"usage\"></a>\n\nA user with the `create` permission creates a link and copies 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 reconnect until it either expires or is removed from the tool. Only members who have the `Kick User` permission can use the command.\n\n## Setup<a name=\"setup\"></a>\n\n> \\[!NOTE\\]\n>\n> \ufe0fThis is assuming you already have configured a fully functioning mumble service.\n\n### Alliance Auth Plugin<a name=\"alliance-auth-plugin\"></a>\n\n#### Step 1: Install the Package<a name=\"step-1-install-the-package\"></a>\n\nMake sure you're in the virtual environment (venv) of your Alliance Auth installation. Then install the latest release directly from PyPi.\n\n```shell\npip install allianceauth-mumbletemps\n```\n\n#### Step 2: Configure Alliance Auth<a name=\"step-2-configure-alliance-auth\"></a>\n\nYou need to add `'mumbletemps',` to your `INSTALLED_APPS` and `APPS_WITH_PUBLIC_VIEWS` in the `local.py` file of your Alliance Auth installation.\n\nThis is fairly simple, configure your AA settings (`local.py`) as follows:\n\n```python\nINSTALLED_APPS += [\n    # Your other apps are here as well\n    \"mumbletemps\",\n]\n\nAPPS_WITH_PUBLIC_VIEWS += [\n    # Other apps with public views might live here\n    \"mumbletemps\",\n]\n\nCELERYBEAT_SCHEDULE[\"mumbletemps_tidy_up_temp_links\"] = {\n    \"task\": \"mumbletemps.tasks.tidy_up_temp_links\",\n    \"schedule\": crontab(minute=\"*/5\"),\n}\n```\n\n> \\[!NOTE\\]\n>\n> If you don't have a list for `APPS_WITH_PUBLIC_VIEWS` yet, then add the whole block\n> from here. This feature has been added in Alliance Auth v3.6.0, so you might not yet\n> have this list in your `local.py`.\n\n#### Step 3: Finalizing the Installation<a name=\"step-3-finalizing-the-installation\"></a>\n\nRun static files collection and migrations.\n\n```shell\npython manage.py collectstatic --noinput\npython manage.py migrate\n```\n\n### Mumble Authenticator<a name=\"mumble-authenticator\"></a>\n\nTo update your mumble authenticator if you git cloned the original repo, we will add my branch as a remote and check out the updated code.\n\n> \\[!IMPORTANT\\]\n>\n> \ufe0fIt is a good idea to back up your `authenticator.ini` file before starting.\n\n1. `cd` into the folder you have the authenticator code in.\n1. `git status` to confirm it is a git repo, and the correct place.\n1. `git remote add upstream git@gitlab.com:aaronkable/mumble-authenticator.git` to add the remote.\n1. `git fetch upstream` to grab the updates.\n1. `git checkout upstream/master` to roll over to my code.\n1. Restart your authenticator with supervisor.\n\n> \\[!NOTE\\]\n>\n> The authenticator.log should show something like:\n>\n> ```\n> Starting AllianceAuth mumble authenticator V:1.0.0 - TempLinks\n> ```\n>\n> If you are on the correct branch and version, if not, you may still be running the default auth version and will need to investigate why. Users will get prompted 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,\ncopy the contents of [my forkfound here](https://gitlab.com/aaronkable/mumble-authenticator)\non top of your current installation.\n\n### Settings<a name=\"settings\"></a>\n\n| Setting                   | Default   | Description                                                              |\n| ------------------------- | --------- | ------------------------------------------------------------------------ |\n| MUMBLE_TEMPS_FORCE_SSO    | `True`    | Setting this to `False` will allow users to auth with the non-sso method |\n| MUMBLE_TEMPS_SSO_PREFIX   | `[TEMP]`  | Display Name Prefix for an SSO'd temp user in mumble                     |\n| MUMBLE_TEMPS_LOGIN_PREFIX | `[*TEMP]` | Display Name Prefix for a non-SSO'd temp user in mumble                  |\n\n### Restart services and you're done.<a name=\"restart-services-and-youre-done\"></a>\n\nRestart your Alliance Auth instance to apply the changes.\n\n```shell\nsudo systemctl restart supervisor.service\n```\n\n### Permissions<a name=\"permissions\"></a>\n\n| Perm                         | Admin Site | Auth Site                         |\n| ---------------------------- | ---------- | --------------------------------- |\n| mumbletemps.create_new_links | None       | Can create and delete Temp Links. |\n\n## Preview<a name=\"preview\"></a>\n\n### Management and Creation<a name=\"management-and-creation\"></a>\n\n![image](https://i.imgur.com/Jl2ihH2.png)\n\n### OPTIONAL Login Screen (Non SSO mode)<a name=\"optional-login-screen-non-sso-mode\"></a>\n\n![Login](https://i.imgur.com/BIRLFmq.png)\n\n### Templink User View<a name=\"templink-user-view\"></a>\n\n![Demo](https://i.imgur.com/G86qAb8.png)\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2019 Aaron Kable  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "Mumble Temp Links plugin for Alliance Auth",
    "version": "3.0.2",
    "project_urls": {
        "Changelog": "https://github.com/Solar-Helix-Independent-Transport/allianceauth-mumble-temp/blob/master/CHANGELOG.md",
        "Documentation": "https://github.com/Solar-Helix-Independent-Transport/allianceauth-mumble-temp/blob/master/README.md",
        "Homepage": "https://github.com/Solar-Helix-Independent-Transport/allianceauth-mumble-temp",
        "Source": "https://github.com/Solar-Helix-Independent-Transport/allianceauth-mumble-temp.git",
        "Tracker": "https://github.com/Solar-Helix-Independent-Transport/allianceauth-mumble-temp/issues"
    },
    "split_keywords": [
        "allianceauth",
        " eveonline",
        " mumble"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ec04ec6a554bdf253355f5416b4c324884c41c4d3699350588fdc5e3b3103909",
                "md5": "c5c6c150a60c4963d47922dcd018dd74",
                "sha256": "45484433188c96bbe6d445fa42b4a187ec7dd5021570644dfddb9d51799beaef"
            },
            "downloads": -1,
            "filename": "allianceauth_mumbletemps-3.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c5c6c150a60c4963d47922dcd018dd74",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 87284,
            "upload_time": "2024-07-05T10:30:24",
            "upload_time_iso_8601": "2024-07-05T10:30:24.822500Z",
            "url": "https://files.pythonhosted.org/packages/ec/04/ec6a554bdf253355f5416b4c324884c41c4d3699350588fdc5e3b3103909/allianceauth_mumbletemps-3.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2541a7b68e20442ef5f9a448965b5090ecb347e3f939c20e23f7dc52894d6adf",
                "md5": "d9e542fbfa6e43acb04e8ffd6d3634e0",
                "sha256": "608db812e7e13ac1ef13afbb8020f0fd42d4794ba0ad7a43561cb2e846e03114"
            },
            "downloads": -1,
            "filename": "allianceauth_mumbletemps-3.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "d9e542fbfa6e43acb04e8ffd6d3634e0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 61259,
            "upload_time": "2024-07-05T10:30:26",
            "upload_time_iso_8601": "2024-07-05T10:30:26.954795Z",
            "url": "https://files.pythonhosted.org/packages/25/41/a7b68e20442ef5f9a448965b5090ecb347e3f939c20e23f7dc52894d6adf/allianceauth_mumbletemps-3.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-05 10:30:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Solar-Helix-Independent-Transport",
    "github_project": "allianceauth-mumble-temp",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "allianceauth-mumbletemps"
}
        
Elapsed time: 0.28057s