mirror of
https://gitlab.com/allianceauth/allianceauth.git
synced 2025-07-09 12:30:15 +02:00
68 lines
3.0 KiB
Markdown
68 lines
3.0 KiB
Markdown
# Auto Groups
|
|
|
|
Auto Groups allows you to automatically place users of certain states into corp or alliance-based groups. These groups are created when the first user is added to them and removed when the configuration is deleted.
|
|
|
|
## Installation
|
|
|
|
- Add `'allianceauth.eveonline.autogroups',` to `INSTALLED_APPS` in your `local.py`
|
|
|
|
Perform Django Maintenance and restart our Web Service and Workers.
|
|
|
|
::::{tabs}
|
|
:::{group-tab} Bare Metal
|
|
|
|
```shell
|
|
python manage.py migrate
|
|
python manage.py collectstatic --noinput
|
|
supervisorctl restart myauth:
|
|
```
|
|
|
|
:::
|
|
:::{group-tab} Containerized
|
|
|
|
```shell
|
|
docker compose --env-file=.env up -d
|
|
docker compose exec allianceauth_gunicorn bash
|
|
auth migrate
|
|
auth collectstatic
|
|
```
|
|
|
|
:::
|
|
::::
|
|
|
|
All other settings are controlled via the admin panel under the `Eve_Autogroups` section.
|
|
|
|
## Configuring a group
|
|
|
|
When you create an autogroup config, you will be given the following options:
|
|
|
|
|
|
|
|
:::{warning}
|
|
After creating a group, you won't be able to change the Corp and Alliance group prefixes, name source, and the replace spaces settings. Make sure you configure these the way you want before creating the config. If you need to change these, you will have to create a new autogroup config.
|
|
:::
|
|
|
|
- States select which states will be added to automatic Corp/Alliance groups
|
|
- Corp/Alliance groups checkbox toggles Corp/Alliance autogroups on or off for this config.
|
|
- Corp/Alliance group prefix sets the prefix for the group name, e.g., if your corp was called `MyCorp` and your prefix was `Corp`, your autogroup name would be created as `Corp MyCorp`. This field accepts leading/trailing spaces.
|
|
- Corp/Alliance name source sets the source of the Corp/Alliance name used in creating the group name. Currently, the options are Full name and Ticker.
|
|
- Replace spaces allows you to replace spaces in the autogroup name with the value in the replace spaces with field. This can be blank.
|
|
|
|
## Permissions
|
|
|
|
Auto Groups are configured via models in the Admin Interface, a user will require the `Staff` Flag in addition to the following permissions.
|
|
|
|
```{eval-rst}
|
|
+-------------------------------------------+------------------+----------------+
|
|
| Permission | Admin Site | Auth Site |
|
|
+===========================================+==================+================+
|
|
| eve_autogroups.add_autogroupsconfig | Can create model | None. |
|
|
+-------------------------------------------+------------------+----------------+
|
|
| eve_autogroups.change_autogroupsconfig | Can edit model | None. |
|
|
+-------------------------------------------+------------------+----------------+
|
|
| eve_autogroups.delete_autogroupsconfig | Can delete model | None. |
|
|
+-------------------------------------------+------------------+----------------+
|
|
```
|
|
|
|
There exists more models that will be automatically created and maintained by this module, they do not require end-user/admin interaction. `managedalliancegroup` `managedcorpgroups`
|