mirror of
https://gitlab.com/allianceauth/allianceauth.git
synced 2025-12-18 23:05:07 +01:00
Minor Documentation Update (#1019)
Gunicorn needs to be run whilist in the folder for context, folder path is not enough Correct static path, note to check nginx user Capitalization of services and small typos Service examples updated to their latest versions and download links Expanded /var/www chowns for Nginx and Apache examples Add in a troubleshooting note for no images being displayed (permissions issue) and gunicorn not execting (file path context) Correct formatting. Reword a few parts. Remove "new in 1.15".
This commit is contained in:
@@ -24,12 +24,12 @@ When you create an autogroup config you will be given the following options:
|
||||
After creating a group you wont 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 selects which states will be added to automatic corp/alliance groups
|
||||
- States selects 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 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 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.
|
||||
- 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.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Corp Stats
|
||||
|
||||
This module is used to check the registration status of corp members and to determine character relationships, being mains or alts.
|
||||
This module is used to check the registration status of Corp members and to determine character relationships, being mains or alts.
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -10,13 +10,13 @@ Add `'allianceauth.corputils',` to your `INSTALLED_APPS` list in your auth proje
|
||||
|
||||
## Creating a Corp Stats
|
||||
|
||||
Upon initial install, nothing will be visible. For every corp, a model will have to be created before data can be viewed.
|
||||
Upon initial install, nothing will be visible. For every Corp, a model will have to be created before data can be viewed.
|
||||
|
||||

|
||||
|
||||
If you are a superuser, the add button will be immediate visible to you. If not, your user account requires the `add_corpstats` permission.
|
||||
|
||||
Corp Stats requires an EVE SSO token to access data from the EVE Swagger Interface. Upon pressing the Add button, you will be prompted to authenticated. Please select the character who is in the corp you want data for.
|
||||
Corp Stats requires an EVE SSO token to access data from the EVE Swagger Interface. Upon pressing the Add button, you will be prompted to authenticated. Please select the character who is in the Corporation you want data for.
|
||||
|
||||

|
||||
|
||||
@@ -33,7 +33,7 @@ If it fails an error message will be displayed.
|
||||
|
||||

|
||||
|
||||
This bar contains a dropdown menu of all available corps. If the user has the `add_corpstats` permission, a button to add a Corp Stats will be shown.
|
||||
This bar contains a dropdown menu of all available Corporations. If the user has the `add_corpstats` permission, a button to add a Corp Stats will be shown.
|
||||
|
||||
On the right of this bar is a search field. Press enter to search. It checks all characters in all Corp Stats you have view permission to and returns search results.
|
||||
|
||||
@@ -41,7 +41,7 @@ On the right of this bar is a search field. Press enter to search. It checks all
|
||||
|
||||

|
||||
|
||||
An update can be performed immediately by pressing the update button. Anyone who can view the Corp Stats can update it.
|
||||
An update can be performed immediately by pressing the update button. Anyone who can view the Corp Stats can update it.
|
||||
|
||||
### Character Lists
|
||||
|
||||
@@ -60,15 +60,15 @@ Each view contains a sortable and searchable table. The number of listings shown
|
||||
|
||||

|
||||
|
||||
This list contains all main characters in registered in the selected corporation and their alts. Each character has a link to [zKillboard](https://zkillboard.com).
|
||||
This list contains all main characters in registered in the selected Corporation and their alts. Each character has a link to [zKillboard](https://zkillboard.com).
|
||||
|
||||
|
||||
#### Member List
|
||||
|
||||

|
||||
|
||||
The list contains all characters in the corp. Red backgrounds means they are not registered in auth. A link to [zKillboard](https://zkillboard.com) is present for all characters.
|
||||
If registered, the character will also have a main character, main corporation, and main alliance field.
|
||||
The list contains all characters in the Corporation. Red backgrounds means they are not registered in auth. A link to [zKillboard](https://zkillboard.com) is present for all characters.
|
||||
If registered, the character will also have a main character, main Corporation, and main Alliance field.
|
||||
|
||||
#### Unregistered List
|
||||
|
||||
@@ -80,7 +80,7 @@ This list contains all characters not registered on auth. Each character has a l
|
||||
|
||||

|
||||
|
||||
This view is essentially the same as the Corp Stats page, but not specific to a single corp.
|
||||
This view is essentially the same as the Corp Stats page, but not specific to a single Corporation.
|
||||
The search query is visible in the search box.
|
||||
Characters from all Corp Stats to which the user has view access will be displayed. APIs respect permissions.
|
||||
|
||||
@@ -108,7 +108,7 @@ To use this feature, users will require some of the following:
|
||||
|
||||
```
|
||||
|
||||
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 corp'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.
|
||||
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 Corporations'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.
|
||||
|
||||
## Automatic Updating
|
||||
By default Corp Stats are only updated on demand. If you want to automatically refresh on a schedule, add an entry to your project's settings file:
|
||||
@@ -126,12 +126,12 @@ Adjust the crontab as desired.
|
||||
|
||||
>Unrecognized corporation. Please ensure it is a member of the alliance or a blue.
|
||||
|
||||
Corp Stats can only be created for corporations who have a model in the database. These only exist for tenant corps,
|
||||
Corp Stats can only be created for Corporations who have a model in the database. These only exist for tenant corps,
|
||||
corps of tenant alliances, blue corps, and members of blue alliances.
|
||||
|
||||
>Selected corp already has a statistics module.
|
||||
|
||||
Only one Corp Stats may exist at a time for a given corporation.
|
||||
Only one Corp Stats may exist at a time for a given Corporation.
|
||||
|
||||
>Failed to gather corporation statistics with selected token.
|
||||
|
||||
@@ -147,7 +147,7 @@ This occurs when the SSO token is invalid, which can occur when deleted by the u
|
||||
|
||||
>CorpStats for (corp name) cannot update with your ESI token as you have left corp.
|
||||
|
||||
The SSO token's character is no longer in the corp which the Corp Stats is for, and therefore membership data cannot be retrieved.
|
||||
The SSO token's character is no longer in the Corporation which the Corp Stats is for, and therefore membership data cannot be retrieved.
|
||||
|
||||
>HTTPForbidden
|
||||
|
||||
|
||||
@@ -11,8 +11,8 @@ Additional settings are required. Append the following settings to the end of yo
|
||||
FLEETUP_API_ID = '' # The API id from http://fleet-up.com/Api/MyKeys
|
||||
FLEETUP_GROUP_ID = '' # The id of the group you want to pull data from, see http://fleet-up.com/Api/Endpoints#groups_mygroupmemberships
|
||||
|
||||
Once filled out restart gunicorn and celery.
|
||||
Once filled out restart Gunicorn and Celery.
|
||||
|
||||
## Permissions
|
||||
|
||||
The Fleetup module is only visible to users with the `auth | user | view_fleeup` permission.
|
||||
The Fleetup module is only visible to users with the `auth | user | view_fleeup` permission.
|
||||
|
||||
@@ -8,15 +8,15 @@ Add `'allianceauth.hrapplications',` to your `INSTALLED_APPS` list in your auth
|
||||
|
||||
### Creating Forms
|
||||
|
||||
The most common task is creating ApplicationForm models for corps. Only when such models exist will a corp be listed as a choice for applicants. This occurs in the django admin site, so only staff have access.
|
||||
The most common task is creating ApplicationForm models for corps. Only when such models exist will a Corporation be listed as a choice for applicants. This occurs in the Django admin site, so only staff have access.
|
||||
|
||||
The first step is to create questions. This is achieved by creating ApplicationQuestion models, one for each question. Titles are not unique.
|
||||
|
||||
Next step is to create the actual ApplicationForm model. It requires an existing EveCorporationInfo model to which it will belong. It also requires the selection of questions. ApplicationForm models are unique per corp: only one may exist for any given corp concurrently.
|
||||
Next step is to create the actual ApplicationForm model. It requires an existing EveCorporationInfo model to which it will belong. It also requires the selection of questions. ApplicationForm models are unique per Corporation: only one may exist for any given Corporation concurrently.
|
||||
|
||||
You can adjust these questions at any time. This is the preferred method of modifying the form: deleting and recreating will cascade the deletion to all received applications from this form which is usually not intended.
|
||||
|
||||
Once completed the corp will be available to receive applications.
|
||||
Once completed the Corporation will be available to receive applications.
|
||||
|
||||
### Reviewing Applications
|
||||
|
||||
@@ -63,11 +63,11 @@ This is the model representation of a question. It contains a title, and a field
|
||||
|
||||
### ApplicationForm
|
||||
|
||||
This is the template for an application. It points at a corp, with only one form allowed per corp. It also points at ApplicationQuestion models. When a user creates an application, they will be prompted with each question the form includes at the given time. Modifying questions in a form after it has been created will not be reflected in existing applications, so it's perfectly fine to adjust them as you see fit. Changing corps however is not advisable, as existing applications will point at the wrong corp after they've been submitted, confusing reviewers.
|
||||
This is the template for an application. It points at a Corporation, with only one form allowed per Corporation. It also points at ApplicationQuestion models. When a user creates an application, they will be prompted with each question the form includes at the given time. Modifying questions in a form after it has been created will not be reflected in existing applications, so it's perfectly fine to adjust them as you see fit. Changing Corporations however is not advisable, as existing applications will point at the wrong Corporation after they've been submitted, confusing reviewers.
|
||||
|
||||
### Application
|
||||
|
||||
This is the model representation of a completed application. It references an ApplicationForm from which it was spawned which is where the corp specificity comes from. It points at a user, contains info regarding its reviewer, and has a status. Shortcut properties also provide the applicant's main character, the applicant's APIs, and a string representation of the reviewer (for cases when the reviewer doesn't have a main character or the model gets deleted).
|
||||
This is the model representation of a completed application. It references an ApplicationForm from which it was spawned which is where the Corporation specificity comes from. It points at a user, contains info regarding its reviewer, and has a status. Shortcut properties also provide the applicant's main character, the applicant's APIs, and a string representation of the reviewer (for cases when the reviewer doesn't have a main character or the model gets deleted).
|
||||
|
||||
### ApplicationResponse
|
||||
|
||||
@@ -81,7 +81,7 @@ This is a reviewer's comment on an application. Points at the application, point
|
||||
|
||||
### No corps accepting applications
|
||||
|
||||
Ensure there are ApplicationForm models in the admin site. Ensure the user does not already have an application to these corps. If the users wishes to re-apply they must first delete their completed application
|
||||
Ensure there are ApplicationForm models in the admin site. Ensure the user does not already have an application to these Corporations. If the users wishes to re-apply they must first delete their completed application
|
||||
|
||||
### Reviewer unable to complete application
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
New in 2.0
|
||||
```
|
||||
|
||||
Each service's username or nickname, depending on which the service supports, can be customised through the use of the Name Formatter Config provided the service supports custom formats. This config can be found in the admin panel under **Services -> Name format config**
|
||||
Each service's username or nickname, depending on which the service supports, can be customised through the use of the Name Formatter config provided the service supports custom formats. This config can be found in the admin panel under **Services -> Name format config**
|
||||
|
||||
Currently the following services support custom name formats:
|
||||
|
||||
@@ -37,7 +37,7 @@ Currently the following services support custom name formats:
|
||||
|
||||
```eval_rst
|
||||
.. note::
|
||||
It's important to note here, before we get into what you can do with a name formatter, that before the generated name is passed off to the service to create an account it will be sanitised to remove characters (the letters and numbers etc) that the service cannot support. This means that, despite what you configured, the service may display something different. It is up to you to test your formatter and understand how your format may be disrupted by a certain services sanitisation function.
|
||||
It's important to note here, before we get into what you can do with a name formatter, that before the generated name is passed off to the service to create an account it will be sanitised to remove characters (the letters and numbers etc.) that the service cannot support. This means that, despite what you configured, the service may display something different. It is up to you to test your formatter and understand how your format may be disrupted by a certain services sanitisation function.
|
||||
```
|
||||
|
||||
## Available format data
|
||||
@@ -53,14 +53,14 @@ The following fields are available from a users account and main character:
|
||||
- `alliance_id`
|
||||
- `alliance_name`
|
||||
- `alliance_ticker`
|
||||
- `alliance_or_corp_name` (defaults to corp name if there is no alliance)
|
||||
- `alliance_or_corp_ticker` (defaults to corp ticker if there is no alliance)
|
||||
- `alliance_or_corp_name` (defaults to Corporation name if there is no Alliance)
|
||||
- `alliance_or_corp_ticker` (defaults to Corporation ticker if there is no Alliance)
|
||||
|
||||
## Building a formatter string
|
||||
|
||||
The name formatter uses the advanced string formatting specified by [PEP-3101](https://www.python.org/dev/peps/pep-3101/). Anything supported by this specification is supported in a name formatter.
|
||||
|
||||
A more digestable documentation of string formatting in Python is available on the [PyFormat](https://pyformat.info/) website.
|
||||
A more digestible documentation of string formatting in Python is available on the [PyFormat](https://pyformat.info/) website.
|
||||
|
||||
Some examples of strings you could use:
|
||||
```eval_rst
|
||||
|
||||
@@ -1,10 +1,5 @@
|
||||
# Permissions Auditing
|
||||
|
||||
```eval_rst
|
||||
.. note::
|
||||
New in 1.15
|
||||
```
|
||||
|
||||
Access to most of Alliance Auth's features are controlled by Django's permissions system. In order to help you secure your services, Alliance Auth provides a permissions auditing tool.
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## Overview
|
||||
|
||||
In Alliance Auth v1 admins were able to define which corporations and alliances were to be considered "members" with full permissions and "blues" with restricted permissions. The state system is the replacement for these static definitions: admins can now create as many states as desired, as well as extend membership to specific characters.
|
||||
In Alliance Auth v1 admins were able to define which Corporations and Alliances were to be considered "members" with full permissions and "blues" with restricted permissions. The state system is the replacement for these static definitions: admins can now create as many states as desired, as well as extend membership to specific characters.
|
||||
|
||||
## Creating a State
|
||||
States are created through your installation's admin site. Upon install three states are created for you: `Member`, `Blue`, and `Guest`. New ones can be created like any other Django model by users with the appropriate permission (`authentication | state | Can add state`) or superusers.
|
||||
@@ -27,10 +27,10 @@ Checking this box means this state is available to all users. There isn't much u
|
||||
This lets you select which characters the state is available to. Characters can be added by selecting the green plus icon.
|
||||
|
||||
### Member Corporations
|
||||
This lets you select which corporations the state is available to. Corporations can be added by selecting the green plus icon.
|
||||
This lets you select which Corporations the state is available to. Corporations can be added by selecting the green plus icon.
|
||||
|
||||
### Member Alliances
|
||||
This lets you select which alliances the state is available to. Alliances can be added by selecting the gree plus icon.
|
||||
This lets you select which Alliances the state is available to. Alliances can be added by selecting the green plus icon.
|
||||
|
||||
## Determining a User's State
|
||||
States are mutually exclusive, meaning a user can only be in one at a time.
|
||||
@@ -45,5 +45,3 @@ Assigned states are visible in the `Users` section of the `Authentication` admin
|
||||
If no states are available to a user's main character, or their account has been deactivated, they are assigned to a catch-all `Guest` state. This state cannot be deleted nor can its name be changed.
|
||||
|
||||
The `Guest` state allows permissions to be granted to users who would otherwise not get any. For example access to public services can be granted by giving the `Guest` state a service access permission.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user