diff --git a/docs/features/fleetup.md b/docs/features/fleetup.md index 4170a93d..f484a0b4 100644 --- a/docs/features/fleetup.md +++ b/docs/features/fleetup.md @@ -2,6 +2,19 @@ ## Installation -Add `allianceauth.fleetup` to your `INSTALLED_APPS` setting. In `myauth/settings/local.py`: +Add `allianceauth.fleetup` to your auth project's `INSTALLED_APPS` setting. - INSTALLED_APPS += ['allianceauth.fleetup'] \ No newline at end of file + INSTALLED_APPS += ['allianceauth.fleetup'] + +Additional settings are required. Append the following settings to the end of your auth project's settings file and fill them out. + + FLEETUP_APP_KEY = '' # The app key from http://fleet-up.com/Api/MyApps + FLEETUP_USER_ID = '' # The user id from http://fleet-up.com/Api/MyKeys + 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. + +## Permissions + +The Fleetup module is only visible to users with the `auth | user | view_fleeup` permission. \ No newline at end of file diff --git a/docs/features/index.md b/docs/features/index.md index 5acb3360..6bbcf39f 100644 --- a/docs/features/index.md +++ b/docs/features/index.md @@ -6,10 +6,10 @@ :caption: Features Contents states - hrapplications - corpstats groups autogroups + hrapplications + corpstats permissions_tool nameformats fleetup