more automated upgrades

This commit is contained in:
Ariel Rin
2023-10-27 22:19:28 +10:00
parent ffb526ab0c
commit 906c589f14
28 changed files with 96 additions and 133 deletions

View File

@@ -18,11 +18,9 @@ When you create an autogroup config you will be given the following options:
![Create Autogroup page](/_static/images/features/apps/autogroups/group-creation.png)
```{eval-rst}
.. warning::
:::{warning}
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
- Corp/Alliance groups checkbox toggles Corp/Alliance autogroups on or off for this config.

View File

@@ -2,7 +2,7 @@
**Alliance Auth** comes with a set of apps (also called plugin-apps) which provide basic functions useful to many organizations in Eve Online like a fleet schedule and a timerboard. This section describes which apps are available and how to install and use them. Please note that any app need to be installed before it can be used.
```{toctree}
:::{toctree}
:maxdepth: 1
autogroups
@@ -13,4 +13,4 @@ optimer
permissions_tool
srp
timerboard
```
:::

View File

@@ -10,11 +10,9 @@ You can open the admin site by clicking on "Admin" in the drop down menu for a u
For small to medium size alliances it is often sufficient to have no more then two superuser admins (admins that also are superusers). Having two admins usually makes sense, so you can have one primary and one backup.
```{eval-rst}
.. warning::
:::{warning}
Superusers have read & write access to everything on your AA installation. Superusers also automatically have all permissions and therefore access to all features of your apps. Therefore we recommend to be very careful to whom you give superuser privileges.
```
:::
## Setup for large installations
For large alliances and coalitions you may want to have a couple of administrators to be able to distribute and handle the work load. However, having a larger number of superusers may be a security concern.
@@ -41,10 +39,9 @@ To create a staff admin you need to do two things:
Access to the admin site is restricted. Users needs to have the `is_staff` property to be able to open the site at all. The superuser that is created during the installation
process will automatically have access to the admin site.
```{eval-rst}
.. hint::
:::{hint}
Without any permissions a "staff user" can open the admin site, but can neither view nor edit anything except for viewing the list of permissions.
```
:::
### Permissions for common admin tasks

View File

@@ -2,7 +2,7 @@
Managing access to applications and services is one of the core functions of **Alliance Auth**. The related key concepts and functionalities are describes in this section.
```{toctree}
:::{toctree}
:maxdepth: 1
dashboard
@@ -11,4 +11,4 @@ groups
analytics
notifications
admin_site
```
:::

View File

@@ -2,7 +2,7 @@
Learn about the features of **Alliance Auth** and how to install and use them.
```{toctree}
:::{toctree}
:maxdepth: 1
overview
@@ -10,4 +10,4 @@ core/index
services/index
apps/index
community/index
```
:::

View File

@@ -4,7 +4,7 @@
## Supported Services
```{toctree}
:::{toctree}
:maxdepth: 1
discord
@@ -15,13 +15,13 @@ phpbb3
smf
teamspeak3
xenforo
```
:::
## Tools
```{toctree}
:::{toctree}
:maxdepth: 1
nameformats
permissions
```
:::

View File

@@ -6,11 +6,9 @@ Mumble is a free voice chat server. While not as flashy as TeamSpeak, it has all
Note that this guide assumes that you have installed Auth with the official :doc:`/installation/allianceauth` guide under ``/home/allianceserver`` and that it is called ``myauth``. Accordingly it assumes that you have a service user called ``allianceserver`` that is used to run all Auth services under supervisor.
```
```{eval-rst}
.. warning::
:::{warning}
This guide is currently for Ubuntu only.
```
:::
## Installations
### Installing Mumble Server

View File

@@ -70,12 +70,10 @@ Some examples of strings you could use:
+------------------------------------------+---------------------------+
```
```{eval-rst}
.. important::
:::{important}
For most services, name formats only take effect when a user creates an account. This means if you create or update a name formatter it wont retroactively alter the format of users names. There are some exceptions to this where the service updates nicknames on a periodic basis. Check the service's documentation to see which of these apply.
```
:::
```{eval-rst}
.. important::
:::{important}
You must only create one formatter per service per state. E.g. don't create two formatters for Mumble for the Member state. In this case one of the formatters will be used and it may not be the formatter you are expecting.
```
:::

View File

@@ -6,10 +6,9 @@ In the past, access to services was dictated by a list of settings in `settings.
Instead of granting access to services by the previous rigid structure, access to services is now granted by the built in Django permissions system. This means that service access can be more granular, allowing only certain states, certain groups, for instance Corp CEOs, or even individual user access to each enabled service.
```{eval-rst}
.. important::
:::{important}
If you grant access to an individual user, they will have access to that service regardless of whether or not they are a member.
```
:::
Each service has an access permission defined, named like `Can access the <service name> service`.
@@ -19,10 +18,9 @@ A user can be granted the same permission from multiple sources. e.g. they may h
## Removing access
```{eval-rst}
.. danger::
:::{danger}
Access removal is processed immediately after removing a permission from a user or group. If you remove access from a large group, such as Member, it will immediately remove all users from that service.
```
:::
When you remove a service permission from a user, a signal is triggered which will activate an immediate permission check. For users this will trigger an access check for all services. For groups, due to the potential extra load, only the services whose permissions have changed will be verified, and only the users in that group.

View File

@@ -48,18 +48,18 @@ unzip smf_2-1-2_install.zip
Now we need to move this to our web directory. Usually `/var/www/forums`.
```shell
mv smf /var/www/forums
````
```
The web server needs read/write permission to this folder
Apache: `chown -R www-data:www-data /var/www/forums`
Nginx: `chown -R nginx:nginx /var/www/forums`
```{eval-rst}
.. tip::
:::{tip}
Nginx: Some distributions use the ``www-data:www-data`` user:group instead of ``nginx:nginx``. If you run into problems with permissions try it instead.
..
```
:::
### Database Preparation