1# EveSSO Plugin for DokuWiki
2
3DokuWiki authentication via eve online SSO and access control for corporations/alliances/factions
4
5[EveSSO on DokuWiki.org](https://www.dokuwiki.org/plugin:evesso)
6
7## Installation
8
9Search and install the plugin using the [Plugin Manager](https://www.dokuwiki.org/plugin:plugin). Refer to [Plugins](https://www.dokuwiki.org/plugins) on how to install plugins manually.
10
11## Updating
12
13### Updating from version 2021-11-02 or earlier
14
15EVESSO change the way eve groups are named.
16They used to be:
17* eve-corp-*corporation_name*
18* eve-alliance-*alliance_name*
19* eve-faction-*faction_name*
20* Group names had space replaced by underscore and dot replaced with hyphen-minus
21
22Now they're:
23* (corporation)*corporation_name*
24* (alliance)*alliance_name*
25* (faction)*faction_name*
26* Names are identical to in-game names
27
28## Configuration
29
30#### Required Steps
311. Open the wiki in your browser
321. Login on a admin account
331. Go to `admin` > `Configuration Settings`
341. Go to `Authentication` > `authtype` and select `EVESSO`
351. Go to the `Evesso` section and enter your data from your [eve online developer app](https://developers.eveonline.com/applications)
36    * `callback` (Callback URL)
37    * `eveonline-key` (Client ID)
38    * `eveonline-secret` (Secret Key)
39    * :warning: Do **not** change `singleService` (That will lock you out of the wiki)
401. Save the settings
41
42#### Disable registration with email (Optional)
43
441. Open the wiki in your browser
451. Login on a admin account
461. Check `Evesso` > ` register-on-auth`
471. Go to `Authenticatio` > `disableactions`
481. Check `Register`
491. Save the settings
50
51#### Disable login with email (Optional)
52
53:warning:
54This have the potential to permantly lock you out of the wiki.
55It is a good idea [backup the wiki](https://www.dokuwiki.org/faq:backup) before you continue.
56
571. Open the wiki in your browser
581. Logout *(if you're currently logged in)*
591. Login via EveSSO on the character you want to be admin
601. Logout
611. Login on a admin account
621. Go to `Admin` > `User Manager`
631. Click the eve character you want for the admin account
641. Add the group `admin` and click `Save Changes`
651. Logout and login with your EveSSO admin account
661. Go to `Admin` > `Configuration Settings`
671. go to `Evesso` > `singleService` and select `EVESSO (user menu)` or `EVESSO (login page)`
68:warning:
69This step can lock you out of the wiki. Make sure you're logged in on a EveSSO admin account and have a up-to-date backup of the wiki before you continue
701. Save settings
71
72## Access Control
73
74All EVESSO users will have both the `user` and `eveonline` group.
75The will also have auth groups for their corporation, alliance *(if in alliance)*, and faction *(if in faction warfare)*:
76* (corporation)*corporation_name*
77* (alliance)*alliance_name*
78* (faction)*faction_name*
79
80You can change the access control for each auth group in `admin` > `Access Control List Management`
81
82:warning: Do not create your own auth groups starting with those prefixes when using this plugin. They will be deleted when the user login.
83:warning: ACL will allow access if any of the users group allow access
84
85## License
86[GNU General Public License v2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
87
88Original code from [OAuth](https://github.com/cosmocode/dokuwiki-plugin-oauth) and [PHPoAuthLib](https://github.com/Lusitanian/PHPoAuthLib)
89