allianceauth/docs/index.md
2017-01-06 00:11:24 -05:00

1.5 KiB
Raw Blame History

Alliance Auth

Alliance service auth to help large scale alliances manage services. Built for "The 99 Percent" open for anyone to use

Installing

Ubuntu Setup Guide

For other distros, adapt the procedure and find distro-specific alternatives for the dependencies

Using

See the Quick Start Guide

Troubleshooting

Read the list of common problems.

Upgrading

As AllianceAuth is developed, new features are added while old bugs are repaired. Its good practice to keep your instance of AllianceAuth up to date.

Some updates require specific instructions. Refer to their entry in the changelog

In general, the update process has 4 steps:

  • download the latest code
  • generate new models in the database
  • update current models in the database
  • rebuild web cache

To perform each of these steps, youll need to be working from the console in the AllianceAuth directory. Usually cd ~/allianceauth

Start by pulling the code changes:

git pull

Modify settings.py according to the changelog.

For an automated upgrade, run the script:

bash update.sh

For a manual upgrade, execute the commands in this order:

sudo pip install -r requirements.txt

python manage.py migrate

python manage.py collectstatic
.. toctree::
    :maxdepth: 3
    :caption: Contents

    features/index
    installation/index
    maintenance/index
    development/index