diff --git a/docs/_static/images/features/corpstats/api_index.png b/docs/_static/images/features/corpstats/api_index.png deleted file mode 100644 index 53357c70..00000000 Binary files a/docs/_static/images/features/corpstats/api_index.png and /dev/null differ diff --git a/docs/_static/images/features/corpstats/lists.png b/docs/_static/images/features/corpstats/lists.png new file mode 100644 index 00000000..f5bf4dd1 Binary files /dev/null and b/docs/_static/images/features/corpstats/lists.png differ diff --git a/docs/_static/images/features/corpstats/main_list.png b/docs/_static/images/features/corpstats/main_list.png new file mode 100644 index 00000000..d44f0bd5 Binary files /dev/null and b/docs/_static/images/features/corpstats/main_list.png differ diff --git a/docs/_static/images/features/corpstats/member_list.png b/docs/_static/images/features/corpstats/member_list.png index b13f4009..d03c485b 100644 Binary files a/docs/_static/images/features/corpstats/member_list.png and b/docs/_static/images/features/corpstats/member_list.png differ diff --git a/docs/_static/images/features/corpstats/navbar.png b/docs/_static/images/features/corpstats/navbar.png index 781112de..ebb15b97 100644 Binary files a/docs/_static/images/features/corpstats/navbar.png and b/docs/_static/images/features/corpstats/navbar.png differ diff --git a/docs/_static/images/features/corpstats/search_view.png b/docs/_static/images/features/corpstats/search_view.png index 6b191071..1295fd88 100644 Binary files a/docs/_static/images/features/corpstats/search_view.png and b/docs/_static/images/features/corpstats/search_view.png differ diff --git a/docs/_static/images/features/corpstats/table_controls.png b/docs/_static/images/features/corpstats/table_controls.png new file mode 100644 index 00000000..48c4d36f Binary files /dev/null and b/docs/_static/images/features/corpstats/table_controls.png differ diff --git a/docs/_static/images/features/corpstats/unregistered_list.png b/docs/_static/images/features/corpstats/unregistered_list.png new file mode 100644 index 00000000..dbbc8a75 Binary files /dev/null and b/docs/_static/images/features/corpstats/unregistered_list.png differ diff --git a/docs/_static/images/features/permissions_tool/audit.png b/docs/_static/images/features/permissions_tool/audit.png new file mode 100644 index 00000000..d9c59f21 Binary files /dev/null and b/docs/_static/images/features/permissions_tool/audit.png differ diff --git a/docs/_static/images/features/permissions_tool/overview.png b/docs/_static/images/features/permissions_tool/overview.png new file mode 100644 index 00000000..fd57b94d Binary files /dev/null and b/docs/_static/images/features/permissions_tool/overview.png differ diff --git a/docs/_static/images/installation/auth/cloudflare/page_rules.jpg b/docs/_static/images/installation/auth/cloudflare/page_rules.jpg new file mode 100644 index 00000000..ddaec23b Binary files /dev/null and b/docs/_static/images/installation/auth/cloudflare/page_rules.jpg differ diff --git a/docs/development/index.md b/docs/development/index.md index 0e0fe4fc..146f2cf3 100644 --- a/docs/development/index.md +++ b/docs/development/index.md @@ -6,4 +6,5 @@ documentation integrating-services menu-hooks + url-hooks ``` diff --git a/docs/features/corpstats.md b/docs/features/corpstats.md index 5441dd66..914a0fc1 100644 --- a/docs/features/corpstats.md +++ b/docs/features/corpstats.md @@ -29,13 +29,7 @@ If it fails an error message will be displayed. This bar contains a dropdown menu of all available corps. If the user has the `add_corpstats` permission, a button to add a Corp Stats will be shown. -On the right of this bar is a search field. Press enter to search. It checks all characters in all Corp Stats you have view permission to and returns search results. Generic searches (such as 'a') will be slow. - -### Registration Index - -![Registration Index](/_static/images/features/corpstats/api_index.png) - -This is a visual indication of the number of registered characters. +On the right of this bar is a search field. Press enter to search. It checks all characters in all Corp Stats you have view permission to and returns search results. ### Last Update @@ -45,17 +39,38 @@ Corp Stats automatically update every 6 hours. An update can be performed immedi Only superusers and the creator of the Corp Stat can trigger an immediate update. -### Member List +### Character Lists + +![lists](/_static/images/features/corpstats/lists.png) + +Three views are available: + - main characters and their alts + - registered characters and their main character + - unregistered characters + +Each view contains a sortable and searchable table. The number of listings shown can be increased with a dropdown selector. Pages can be changed using the controls on the bottom-right of the table. Each list is searchable at the top-right. Tables can be re-ordered by clicking on column headings. + +![table control locations](/_static/images/features/corpstats/table_controls.png) + +#### Main List + +![main list](/_static/images/features/corpstats/main_list.png) + +This list contains all main characters in registered in the selected corporation and their alts. Each character has a link to [zKillboard](https://zkillboard.com). + + +#### Member List ![member list](/_static/images/features/corpstats/member_list.png) -The list contains all characters in the corp. Red backgrounds means they are not registered in auth. If registered, and the user has the required permission to view APIs, a link to JackKnife will be present. -A link to zKillboard is present for all characters. +The list contains all characters in the corp. Red backgrounds means they are not registered in auth. A link to [zKillboard](https://zkillboard.com) is present for all characters. If registered, the character will also have a main character, main corporation, and main alliance field. -This view is paginated: use the navigation arrows to view more pages (sorted alphabetically by character name), or search for a specific character. +#### Unregistered List -![pagination buttons](/_static/images/features/corpstats/pagination.png) +![unregistered_list](/_static/images/features/corpstats/unregistered_list.png) + +This list contains all characters not registered on auth. Each character has a link to [zKillboard](https://zkillboard.com). ## Search View @@ -65,7 +80,6 @@ This view is essentially the same as the Corp Stats page, but not specific to a The search query is visible in the search box. Characters from all Corp Stats to which the user has view access will be displayed. APIs respect permissions. -This view is paginated: use the navigation arrows to view more pages (sorted alphabetically by character name). ## Permissions diff --git a/docs/features/permissions_tool.md b/docs/features/permissions_tool.md index 016bf972..fb2f265d 100644 --- a/docs/features/permissions_tool.md +++ b/docs/features/permissions_tool.md @@ -18,7 +18,7 @@ When a user has access to the tool they will see the "Permissions Audit" menu it The first page gives you a general overview of permissions and how many users have access to each permission. -![permissions overview](https://i.imgur.com/XALVFtc.png) +![permissions overview](/_static/images/features/permissions_tool/overview.png) **App**, **Model** and **Code Name** contain the internal details of the permission while **Name** contains the name/description you'll see in the admin panel. @@ -34,6 +34,6 @@ Clicking on the **Code Name** link will take you to the [Permissions Audit Page] The permissions audit page will give you an overview of all the users who have access to this permission either directly or granted via group membership. -![permissions audit](https://i.imgur.com/XjnfC9Z.png) +![permissions audit](/_static/images/features/permissions_tool/audit.png) Please note that users may appear multiple times if this permission is granted via multiple sources. diff --git a/docs/installation/auth/cloudflare.md b/docs/installation/auth/cloudflare.md index 50bdd785..13ec9f71 100644 --- a/docs/installation/auth/cloudflare.md +++ b/docs/installation/auth/cloudflare.md @@ -26,7 +26,7 @@ CloudFlare blocks ports outside 80 and 443 on hosts it protects. This means, if Now we need to configure the https redirect to force all traffic to https. Along the top bar of CloudFlare, select `Page Rules`. Add a new rule, Pattern is example.com, toggle the `Always use https` to ON, and save. It’ll take a few minutes to propagate. -![infographic](http://i.stack.imgur.com/VUBvo.jpg) +![infographic](/_static/images/installation/auth/cloudflare/page_rules.jpg) ## Update Auth URLs diff --git a/docs/installation/services/phpbb3.md b/docs/installation/services/phpbb3.md index 5887d9d0..5d6e647c 100644 --- a/docs/installation/services/phpbb3.md +++ b/docs/installation/services/phpbb3.md @@ -61,11 +61,11 @@ Before users can see the forums, we need to remove the install directory ### Enabling Avatars AllianceAuth sets user avatars to their character portrait when the account is created or password reset. We need to allow external URLs for avatars for them to behave properly. Navigate to the admin control panel for phpbb3, and under the `General` tab, along the left navigation bar beneath `Board Configuration`, select `Avatar Settings`. Set `Enable Remote Avatars` to `Yes` and then `Submit`. -![location of the remote avatar setting](http://i.imgur.com/eWrotRX.png) +![location of the remote avatar setting](/_static/images/installation/services/phpbb3/avatar_settings.png) You can allow members to overwrite the portrait with a custom image if desired. Navigate to `Users and Groups`, `Group Permissions`, select the appropriate group (usually `Member` if you want everyone to have this ability), expand `Advanced Permissions`, under the `Profile` tab, set `Can Change Avatars` to `Yes`, and press `Apply Permissions`. -![location of change avatar setting](http://i.imgur.com/Nc6Rzo9.png) +![location of change avatar setting](/_static/images/installation/services/phpbb3/avatar_permissions.png) ## Setup Complete You’ve finished the steps required to make AllianceAuth work with phpBB. Play around with it and make it your own.