# AllianceAuth CharLink
[](https://pypi.org/project/aa-charlink/)
A simple app for AllianceAuth that allows users to link each character to all the AllianceAuth apps with only 1 login action.
## Overview
### Basic usage
1. Select which app you want to link your character to
2. Login on CPP site
3. Character linked to the selected apps
### Auditing
Users with the appropriate permission (see [permissions](#permissions)) can audit the linked characters of the users of their corporation, alliance or auth state. A link will appear on top of the main page of the app and will redirect to a page with a table of all the linked characters of the users of the selected corporation.
A user can be audited by clicking on the link on the `Main Character` column.
App Audit: Users can now audit character based on the apps they have access to. Select the app you want to audit from the dropdown menu in the audit page.
Admin App status: users with `is_superuser` can now see the list of imported apps and the ones with issues with the import.
## Installation
1. Install the app with
```shell
pip install aa-charlink
```
2. Add `'charlink',` to your `INSTALLED_APPS` in `local.py`
3. Run migrations and collectstatic
```shell
python manage.py migrate
python manage.py collectstatic
```
## Current apps
I've opened an [issue](https://github.com/Maestro-Zacht/aa-charlink/issues/1) to track the apps that have a default integration in CharLink and the WIPs. If you want another app to be supported, please comment on the issue, reach me on the [AllianceAuth discord server](https://discord.gg/fjnHAmk) or ask the developer of the app to implement an [integration via hook](#hook-integration).
## Hook integration
From version 1.1.0, CharLink supports hook integration. If you want to integrate your app with CharLink, you need to register a hook in the `auth_hooks.py` file:
```python
@hooks.register('charlink')
def register_charlink_hook():
return 'testauth.testapp.charlink_hook'
```
The hook has to return a string with the import path of the module containing the app integration. The module must contain a variable called `app_import` which is an instance of `charlink.app_imports.utils.AppImport`. You can find the documentation of the class in the [`utils.py`](./charlink/app_imports/utils.py) and some examples in the [imports folder](./charlink/imports).
## Ignoring apps
Ignoring apps has been moved from settings to the CharLink Admin page. In order to ingore an app, or one of its login options, click on the related eye button in this page.
## Default selection
From version 1.10.0, login options can have their default selection changed by the admin. This can be done in the CharLink Admin page using the "Default selection" button.
## Smartfilters
If [Securegroups](https://github.com/Solar-Helix-Independent-Transport/allianceauth-secure-groups) is installed, CharLink exports the following smartfilters:
- Compliance filter: checks if the user has added all his characters to the selected apps.
## Permissions
| Name | Description |
| ------------------------ | ---------------------------------------------------------- |
| `charlink.view_corp` | Can view linked character of members of their corporation. |
| `charlink.view_alliance` | Can view linked character of members of their alliance. |
| `charlink.view_state` | Can view linked character of members of their auth state. |
| `charlink.view_admin` | Can view CharLink Admin page. |
## Login page url
If you want to setup a template override to link the "Add character" button to the login page of this package, set the `a` element to:
```html
<a href="{% url 'charlink:index' %}" class="btn btn-primary flex-fill m-1" title="{% translate 'Add Character' %}">
<span class="d-md-inline m-2">{% translate 'Add Character' %}</span>
</a>
```
## Known issues
- For AFAT is not possible to check the validity of the added character's token.
Raw data
{
"_id": null,
"home_page": null,
"name": "aa-charlink",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.10",
"maintainer_email": null,
"keywords": "allianceauth, eveonline, allianceauth_charlink, charlink",
"author": null,
"author_email": "Matteo Ghia <matteo.ghia@yahoo.it>",
"download_url": "https://files.pythonhosted.org/packages/69/e5/83c2e5d81105258c3031f9ee0baf0ccb8564d04f3ed58fa78c24020bb90a/aa_charlink-1.11.0.tar.gz",
"platform": null,
"description": "# AllianceAuth CharLink\n\n[](https://pypi.org/project/aa-charlink/)\n\n\n\nA simple app for AllianceAuth that allows users to link each character to all the AllianceAuth apps with only 1 login action.\n\n## Overview\n\n### Basic usage\n\n1. Select which app you want to link your character to\n \n2. Login on CPP site\n3. Character linked to the selected apps\n \n\n### Auditing\n\nUsers with the appropriate permission (see [permissions](#permissions)) can audit the linked characters of the users of their corporation, alliance or auth state. A link will appear on top of the main page of the app and will redirect to a page with a table of all the linked characters of the users of the selected corporation.\n\nA user can be audited by clicking on the link on the `Main Character` column.\n\nApp Audit: Users can now audit character based on the apps they have access to. Select the app you want to audit from the dropdown menu in the audit page.\nAdmin App status: users with `is_superuser` can now see the list of imported apps and the ones with issues with the import.\n\n## Installation\n\n1. Install the app with\n\n ```shell\n pip install aa-charlink\n ```\n\n2. Add `'charlink',` to your `INSTALLED_APPS` in `local.py`\n3. Run migrations and collectstatic\n\n ```shell\n python manage.py migrate\n python manage.py collectstatic\n ```\n\n## Current apps\n\nI've opened an [issue](https://github.com/Maestro-Zacht/aa-charlink/issues/1) to track the apps that have a default integration in CharLink and the WIPs. If you want another app to be supported, please comment on the issue, reach me on the [AllianceAuth discord server](https://discord.gg/fjnHAmk) or ask the developer of the app to implement an [integration via hook](#hook-integration).\n\n## Hook integration\n\nFrom version 1.1.0, CharLink supports hook integration. If you want to integrate your app with CharLink, you need to register a hook in the `auth_hooks.py` file:\n\n```python\n@hooks.register('charlink')\ndef register_charlink_hook():\n return 'testauth.testapp.charlink_hook'\n```\n\nThe hook has to return a string with the import path of the module containing the app integration. The module must contain a variable called `app_import` which is an instance of `charlink.app_imports.utils.AppImport`. You can find the documentation of the class in the [`utils.py`](./charlink/app_imports/utils.py) and some examples in the [imports folder](./charlink/imports).\n\n## Ignoring apps\n\nIgnoring apps has been moved from settings to the CharLink Admin page. In order to ingore an app, or one of its login options, click on the related eye button in this page.\n\n## Default selection\n\nFrom version 1.10.0, login options can have their default selection changed by the admin. This can be done in the CharLink Admin page using the \"Default selection\" button.\n\n## Smartfilters\n\nIf [Securegroups](https://github.com/Solar-Helix-Independent-Transport/allianceauth-secure-groups) is installed, CharLink exports the following smartfilters:\n\n- Compliance filter: checks if the user has added all his characters to the selected apps.\n\n## Permissions\n\n| Name | Description |\n| ------------------------ | ---------------------------------------------------------- |\n| `charlink.view_corp` | Can view linked character of members of their corporation. |\n| `charlink.view_alliance` | Can view linked character of members of their alliance. |\n| `charlink.view_state` | Can view linked character of members of their auth state. |\n| `charlink.view_admin` | Can view CharLink Admin page. |\n\n## Login page url\n\nIf you want to setup a template override to link the \"Add character\" button to the login page of this package, set the `a` element to:\n\n```html\n<a href=\"{% url 'charlink:index' %}\" class=\"btn btn-primary flex-fill m-1\" title=\"{% translate 'Add Character' %}\">\n <span class=\"d-md-inline m-2\">{% translate 'Add Character' %}</span>\n</a>\n\n```\n\n## Known issues\n\n- For AFAT is not possible to check the validity of the added character's token.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Character Linker for Alliance Auth",
"version": "1.11.0",
"project_urls": {
"Changelog": "https://github.com/Maestro-Zacht/aa-charlink/releases",
"Homepage": "https://github.com/Maestro-Zacht/aa-charlink",
"Source": "https://github.com/Maestro-Zacht/aa-charlink",
"Tracker": "https://github.com/Maestro-Zacht/aa-charlink/issues"
},
"split_keywords": [
"allianceauth",
" eveonline",
" allianceauth_charlink",
" charlink"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ee7b13fa66878b2b651a1ec22ff14a97fd417c524343a543ac5d611359a5b762",
"md5": "0471b50e597d1f273d6fbe6874549276",
"sha256": "4a3aa39f1f169ac48c2984655322f5a40f2a8ad03b53bef52273f208bcbee0a8"
},
"downloads": -1,
"filename": "aa_charlink-1.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0471b50e597d1f273d6fbe6874549276",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.10",
"size": 82278,
"upload_time": "2025-08-26T16:20:09",
"upload_time_iso_8601": "2025-08-26T16:20:09.874499Z",
"url": "https://files.pythonhosted.org/packages/ee/7b/13fa66878b2b651a1ec22ff14a97fd417c524343a543ac5d611359a5b762/aa_charlink-1.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "69e583c2e5d81105258c3031f9ee0baf0ccb8564d04f3ed58fa78c24020bb90a",
"md5": "926f07a3c4df6f79f32a0daaafee03a0",
"sha256": "b0a3ab003115d8a4561c2fa9d172a74758fbbd20e9eabf32530bceb9b574b0c8"
},
"downloads": -1,
"filename": "aa_charlink-1.11.0.tar.gz",
"has_sig": false,
"md5_digest": "926f07a3c4df6f79f32a0daaafee03a0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.10",
"size": 50868,
"upload_time": "2025-08-26T16:20:11",
"upload_time_iso_8601": "2025-08-26T16:20:11.013861Z",
"url": "https://files.pythonhosted.org/packages/69/e5/83c2e5d81105258c3031f9ee0baf0ccb8564d04f3ed58fa78c24020bb90a/aa_charlink-1.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-26 16:20:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Maestro-Zacht",
"github_project": "aa-charlink",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "aa-charlink"
}
JSON
