Include basic app installation instructions.

This commit is contained in:
Adarnof 2017-12-14 18:01:47 -05:00
parent 770aca923f
commit af7a432f29
9 changed files with 72 additions and 0 deletions

View File

@ -2,6 +2,14 @@
This module is used to check the registration status of corp members and to determine character relationships, being mains or alts.
## Installation
Add `allianceauth.corputils` to your `INSTALLED_APPS` setting and run migrations. In `myauth/settings/local.py`:
INSTALLED_APPS += ['allianceauth.corputils']
Run migrations to complete installation.
## 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.

View File

@ -0,0 +1,9 @@
# Fleet Activity Tracking
## Installation
Add `allianceauth.fleetactivitytracking` to your `INSTALLED_APPS` setting. In `myauth/settings/local.py`:
INSTALLED_APPS += ['allianceauth.fleetactivitytracking']
Run migrations to complete installation.

7
docs/features/fleetup.md Normal file
View File

@ -0,0 +1,7 @@
# Fleetup
## Installation
Add `allianceauth.fleetup` to your `INSTALLED_APPS` setting. In `myauth/settings/local.py`:
INSTALLED_APPS += ['allianceauth.fleetup']

View File

@ -1,5 +1,13 @@
# HR Applications
## Installation
Add `allianceauth.hrapplications` to your `INSTALLED_APPS` setting. In `myauth/settings/local.py`:
INSTALLED_APPS += ['allianceauth.hrapplications']
Run migrations to complete installation.
## Management
### Creating Forms

View File

@ -11,4 +11,9 @@
autogroups
permissions_tool
nameformats
fleetup
fleetactivitytracking
optimer
srp
timerboard
```

9
docs/features/optimer.md Normal file
View File

@ -0,0 +1,9 @@
# Optimer
## Installation
Add `allianceauth.optimer` to your `INSTALLED_APPS` setting. In `myauth/settings/local.py`:
INSTALLED_APPS += ['allianceauth.optimer']
Run migrations to complete installation.

View File

@ -7,6 +7,14 @@
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
Add `allianceauth.permissions_tool` to your `INSTALLED_APPS` setting. In `myauth/settings/local.py`:
INSTALLED_APPS += ['allianceauth.permissions_tool']
## Usage
### Access
In order to grant users access to the permissions auditing tool they will need to be granted the `permissions_tool.audit_permissions` permission or be a superuser.

9
docs/features/srp.md Normal file
View File

@ -0,0 +1,9 @@
# SRP
## Installation
Add `allianceauth.srp` to your `INSTALLED_APPS` setting. In `myauth/settings/local.py`:
INSTALLED_APPS += ['allianceauth.srp']
Run migrations to complete installation.

View File

@ -0,0 +1,9 @@
# Timerboard
## Installation
Add `allianceauth.timerboard` to your `INSTALLED_APPS` setting. In `myauth/settings/local.py`:
INSTALLED_APPS += ['allianceauth.timerboard']
Run migrations to complete installation.