From 5331d194df1a2a09780af64a4165259c6ed90742 Mon Sep 17 00:00:00 2001 From: Adarnof Date: Fri, 2 Mar 2018 01:52:16 -0500 Subject: [PATCH] Instruct selection of only necessary SSO scopes. Standardize instructions of adding app to settings. --- .../project_template/project_name/settings/local.py | 3 ++- docs/features/autogroups.md | 2 +- docs/features/corpstats.md | 6 ++---- docs/features/fleetactivitytracking.md | 6 ++---- docs/features/fleetup.md | 4 +--- docs/features/hrapplications.md | 6 +----- docs/features/optimer.md | 6 +----- docs/features/permissions_tool.md | 4 +--- docs/features/srp.md | 6 +----- docs/features/timerboard.md | 6 +----- docs/installation/auth/apache.md | 2 +- 11 files changed, 14 insertions(+), 37 deletions(-) diff --git a/allianceauth/project_template/project_name/settings/local.py b/allianceauth/project_template/project_name/settings/local.py index fe38338a..ac93427f 100644 --- a/allianceauth/project_template/project_name/settings/local.py +++ b/allianceauth/project_template/project_name/settings/local.py @@ -35,7 +35,8 @@ DATABASES['default'] = { # Register an application at https://developers.eveonline.com for Authentication # & API Access and fill out these settings. Be sure to set the callback URL # to https://example.com/sso/callback substituting your domain for example.com -# Select publicData and all available scopes starting with esi- +# Logging in to auth requires the publicData scope (can be overridden through the +# LOGIN_TOKEN_SCOPES setting). Other apps may require more (see their docs). ESI_SSO_CLIENT_ID = '' ESI_SSO_CLIENT_SECRET = '' ESI_SSO_CALLBACK_URL = '' diff --git a/docs/features/autogroups.md b/docs/features/autogroups.md index 0c11b1b0..c502fcde 100644 --- a/docs/features/autogroups.md +++ b/docs/features/autogroups.md @@ -10,7 +10,7 @@ Auto groups allows you to automatically place users of certain states into Corp ## Installation -Add `allianceauth.eveonline.autogroups` to your `INSTALLED_APPS` and run migrations. All other settings are controlled via the admin panel under the `Eve_Autogroups` section. +Add `'allianceauth.eveonline.autogroups',` to your `INSTALLED_APPS` list and run migrations. All other settings are controlled via the admin panel under the `Eve_Autogroups` section. ## Configuring a group diff --git a/docs/features/corpstats.md b/docs/features/corpstats.md index 7d889f8d..0a274826 100644 --- a/docs/features/corpstats.md +++ b/docs/features/corpstats.md @@ -4,11 +4,9 @@ This module is used to check the registration status of corp members and to dete ## Installation -Add `allianceauth.corputils` to your `INSTALLED_APPS` setting and run migrations. In `myauth/settings/local.py`: +Corp Stats requires access to the `esi-corporations.read_corporation_membership.v1` SSO scope. Update your application on the [EVE Developers site](https://developers.eveonline.com) to ensure it is available. - INSTALLED_APPS += ['allianceauth.corputils'] - -Run migrations to complete installation. +Add `'allianceauth.corputils',` to your `INSTALLED_APPS` list in your auth project's settings file. Run migrations to complete installation. ## Creating a Corp Stats diff --git a/docs/features/fleetactivitytracking.md b/docs/features/fleetactivitytracking.md index 7fc0342f..51aa7eec 100644 --- a/docs/features/fleetactivitytracking.md +++ b/docs/features/fleetactivitytracking.md @@ -2,8 +2,6 @@ ## Installation -Add `allianceauth.fleetactivitytracking` to your `INSTALLED_APPS` setting. In `myauth/settings/local.py`: +Fleet Activity Tracking requires access to the `esi-location.read_location.v1`, `esi-location.read_ship_type.v1`, and `esi-universe.read_structures.v1` SSO scopes. Update your application on the [EVE Developers site](https://developers.eveonline.com) to ensure these are available. - INSTALLED_APPS += ['allianceauth.fleetactivitytracking'] - -Run migrations to complete installation. \ No newline at end of file +Add `'allianceauth.fleetactivitytracking',` to your `INSTALLED_APPS` list in your auth project's settings file. Run migrations to complete installation. \ No newline at end of file diff --git a/docs/features/fleetup.md b/docs/features/fleetup.md index f484a0b4..4fd36a8b 100644 --- a/docs/features/fleetup.md +++ b/docs/features/fleetup.md @@ -2,9 +2,7 @@ ## Installation -Add `allianceauth.fleetup` to your auth project's `INSTALLED_APPS` setting. - - INSTALLED_APPS += ['allianceauth.fleetup'] +Add `'allianceauth.fleetup',` to your auth project's `INSTALLED_APPS` list. Additional settings are required. Append the following settings to the end of your auth project's settings file and fill them out. diff --git a/docs/features/hrapplications.md b/docs/features/hrapplications.md index 53ab6f5a..a498b19f 100644 --- a/docs/features/hrapplications.md +++ b/docs/features/hrapplications.md @@ -2,11 +2,7 @@ ## Installation -Add `allianceauth.hrapplications` to your `INSTALLED_APPS` setting. In `myauth/settings/local.py`: - - INSTALLED_APPS += ['allianceauth.hrapplications'] - -Run migrations to complete installation. +Add `'allianceauth.hrapplications',` to your `INSTALLED_APPS` list in your auth project's settings file. Run migrations to complete installation. ## Management diff --git a/docs/features/optimer.md b/docs/features/optimer.md index ddc96a16..fa62d49e 100644 --- a/docs/features/optimer.md +++ b/docs/features/optimer.md @@ -2,8 +2,4 @@ ## Installation -Add `allianceauth.optimer` to your `INSTALLED_APPS` setting. In `myauth/settings/local.py`: - - INSTALLED_APPS += ['allianceauth.optimer'] - -Run migrations to complete installation. \ No newline at end of file +Add `'allianceauth.optimer',` to your `INSTALLED_APPS` list in your auth project's settings file. Run migrations to complete installation. \ No newline at end of file diff --git a/docs/features/permissions_tool.md b/docs/features/permissions_tool.md index 424413ef..b5f32309 100644 --- a/docs/features/permissions_tool.md +++ b/docs/features/permissions_tool.md @@ -9,9 +9,7 @@ Access to most of Alliance Auth's features are controlled by Django's permission ## Installation -Add `allianceauth.permissions_tool` to your `INSTALLED_APPS` setting. In `myauth/settings/local.py`: - - INSTALLED_APPS += ['allianceauth.permissions_tool'] +Add `'allianceauth.permissions_tool',` to your `INSTALLED_APPS` list in your auth project's settings file. ## Usage diff --git a/docs/features/srp.md b/docs/features/srp.md index 5e34a122..af1142e8 100644 --- a/docs/features/srp.md +++ b/docs/features/srp.md @@ -2,8 +2,4 @@ ## Installation -Add `allianceauth.srp` to your `INSTALLED_APPS` setting. In `myauth/settings/local.py`: - - INSTALLED_APPS += ['allianceauth.srp'] - -Run migrations to complete installation. \ No newline at end of file +Add `'allianceauth.srp',` to your `INSTALLED_APPS` list in your auth project's settings file. Run migrations to complete installation. \ No newline at end of file diff --git a/docs/features/timerboard.md b/docs/features/timerboard.md index 237d1cb2..b3878dc6 100644 --- a/docs/features/timerboard.md +++ b/docs/features/timerboard.md @@ -2,8 +2,4 @@ ## Installation -Add `allianceauth.timerboard` to your `INSTALLED_APPS` setting. In `myauth/settings/local.py`: - - INSTALLED_APPS += ['allianceauth.timerboard'] - -Run migrations to complete installation. \ No newline at end of file +Add `'allianceauth.timerboard',` to your `INSTALLED_APPS` list in your auth project's settings file. Run migrations to complete installation. \ No newline at end of file diff --git a/docs/installation/auth/apache.md b/docs/installation/auth/apache.md index e1974479..9a478e00 100644 --- a/docs/installation/auth/apache.md +++ b/docs/installation/auth/apache.md @@ -1,4 +1,4 @@ -# Apache Setup +# Apache ## Overview