Mathis/allianceauth
1
0
Fork 0
mirror of https://gitlab.com/allianceauth/allianceauth.git synced 2025-12-19 07:15:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document Permissions and other Docs Improvments

Browse Source
This commit is contained in:
Ariel Rin
2020-12-26 16:10:42 +10:00
parent f4c4ae36ed
commit 240d910c9b
18 changed files with 458 additions and 147 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/features/apps/autogroups.md
View File

@@ -33,3 +33,20 @@ When you create an autogroup config you will be given the following options:
- 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`

5
docs/features/apps/corpstats.md
View File

@@ -102,11 +102,6 @@ To use this feature, users will require some of the following:
+---------------------------------------+------------------+----------------------------------------------------+
| corpstats.add_corpstats | Can create model | Can add new corpstats using an SSO token. |
+---------------------------------------+------------------+----------------------------------------------------+
| corpstats.change_corpstats | Can edit model | None. |
+---------------------------------------+------------------+----------------------------------------------------+
| corpstats.remove_corpstats | Can delete model | None. |
+---------------------------------------+------------------+----------------------------------------------------+
```
Users who add a Corp Stats with their token will be granted permissions to view it regardless of the above permissions. View permissions are interpreted in the "OR" sense: a user can view their corporation's Corp Stats without the `view_corp_corpstats` permission if they have the `view_alliance_corpstats` permission, same idea for their state. Note that these evaluate against the user's main character.

17
docs/features/apps/fleetactivitytracking.md
View File

@@ -9,3 +9,20 @@ The Fleet Activity Tracking (FAT) app allows you to track fleet participation.
Fleet Activity Tracking requires access to the `esi-location.read_location.v1`, `esi-location.read_ship_type.v1`, and `esi-universe.read_structures.v1` SSO scopes. Update your application on the [EVE Developers site](https://developers.eveonline.com) to ensure these are available.
Add `'allianceauth.fleetactivitytracking',` to your `INSTALLED_APPS` list in your auth project's settings file. Run migrations to complete installation.
## Permissions
To administer this feature, users will require some of the following.
Users do not require any permissions to interact with FAT Links created.
```eval_rst
+---------------------------------------+------------------+--------------------------------------------------------------------------+
| Permission | Admin Site | Auth Site |
+=======================================+==================+==========================================================================+
| auth.fleetactivitytracking | None | Create and Modify FATLinks |
+---------------------------------------+------------------+--------------------------------------------------------------------------+
| auth.fleetactivitytracking_statistics | None | Can view detailed statistics for corp models and other characters. |
+---------------------------------------+------------------+--------------------------------------------------------------------------+
```

9
docs/features/apps/hrapplications.md
View File

@@ -40,7 +40,9 @@ Any reviewer who can see the application can view the applicant's APIs if they p
## Permissions
The following permissions have an effect on the website above and beyond their usual admin site functions.
To administer this feature, users will require some of the following.
Users do not require any permission to apply to a corporation and fill out the form.
```eval_rst
+---------------------------------------+------------------+----------------------------------------------------+
@@ -54,13 +56,12 @@ The following permissions have an effect on the website above and beyond their u
+---------------------------------------+------------------+----------------------------------------------------+
| hrapplications.reject_applications | None | Can reject applications |
+---------------------------------------+------------------+----------------------------------------------------+
| hrapplications.view_apis | None | Can view applicant API keys, and audit in Jacknife |
+---------------------------------------+------------------+----------------------------------------------------+
| hrapplications.add_applicationcomment | Can create model | Can comment on applications |
+---------------------------------------+------------------+----------------------------------------------------+
```
A user with `auth.human_resources` can only see applications to their own corp.
Best practice is to bundle the `auth.human_resources` permission alongside the `hrapplications.approve_application` and `hrapplications.reject_application` permissions, as in isolation these don't make much sense.
## Models

14
docs/features/apps/optimer.md
View File

@@ -7,3 +7,17 @@ Fleet Operations is an app for organizing and communicating fleet schedules.
## Installation
Add `'allianceauth.optimer',` to your `INSTALLED_APPS` list in your auth project's settings file. Run migrations to complete installation.
## Permissions
To use and administer this feature, users will require some of the following.
```eval_rst
+---------------------------------------+------------------+--------------------------------------------------------------------------+
| Permission | Admin Site | Auth Site |
+=======================================+==================+==========================================================================+
| auth.optimer_view | None | Can view Fleet Operation Timers |
+---------------------------------------+------------------+--------------------------------------------------------------------------+
| auth.optimer_manage | None | Can Manage Fleet Operation timers |
+---------------------------------------+------------------+--------------------------------------------------------------------------+
```

12
docs/features/apps/permissions_tool.md
View File

@@ -37,3 +37,15 @@ The permissions audit page will give you an overview of all the users who have a
![permissions audit](/_static/images/features/apps/permissions_tool/audit.png)
Please note that users may appear multiple times if this permission is granted via multiple sources.
## Permissions
To use this feature, users will require some of the following.
```eval_rst
+---------------------------------------+------------------+--------------------------------------------------------------------------+
| Permission | Admin Site | Auth Site |
+=======================================+==================+==========================================================================+
| permissions_tool.audit_permissions | None | Can view the Permissions Audit tool |
+---------------------------------------+------------------+--------------------------------------------------------------------------+
```

16
docs/features/apps/srp.md
View File

@@ -7,3 +7,19 @@ Ship Replacement helps you to organize ship replacement programs (SRP) for your
## Installation
Add `'allianceauth.srp',` to your `INSTALLED_APPS` list in your auth project's settings file. Run migrations to complete installation.
## Permissions
To use and administer this feature, users will require some of the following.
```eval_rst
+----------------------+------------------+------------------------------------------------------------+
| Permission | Admin Site | Auth Site |
+======================+==================+============================================================+
| auth.access_srp | None | Can create an SRP request from a fleet |
+----------------------+------------------+------------------------------------------------------------+
| auth.srp_management | None | Can Approve and Deny SRP requests, Can create an SRP Fleet |
+----------------------+------------------+------------------------------------------------------------+
| srp.add_srpfleetmain | Can Add Model | Can Create an SRP Fleet |
+----------------------+------------------+------------------------------------------------------------+
```

14
docs/features/apps/timerboard.md
View File

@@ -7,3 +7,17 @@ Structure Timers helps you keep track of both offensive and defensive structure
## Installation
Add `'allianceauth.timerboard',` to your `INSTALLED_APPS` list in your auth project's settings file. Run migrations to complete installation.
## Permissions
To use and administer this feature, users will require some of the following.
```eval_rst
+---------------------------------------+------------------+--------------------------------------------------------------------------+
| Permission | Admin Site | Auth Site |
+=======================================+==================+==========================================================================+
| auth.timer_view | None | Can view Timerboard Timers |
+---------------------------------------+------------------+--------------------------------------------------------------------------+
| auth.timer_manage | None | Can Manage Timerboard timers |
+---------------------------------------+------------------+--------------------------------------------------------------------------+
```