Alliance Auth Plugin
Project description
Secure Groups
Plugin for Auto Group Bot Stuffs for Alliance Auth.
On its own this app does very little! However it leverages any module that is capable of providing a filter. Giving you the ability to add a very wide range of automatic filtration options your groups.
Features
- Manual Groups, either auto join or still request join via Auths Built in Group Management system.
- Auto Groups, process all member states for a filter and add/remove who ever passes/doesn't.
- A Grace on failure feature when already in the group with notifications to users to alow time to rectify
- Pings to users on discord and in auth when they are due for and removed
- Smart Group Filters included with this app:
- Alt in Alliance on account
- Alt in Corp on account
Apps that provide a filter
Information for Third Party Developers can be found Here Not in any particular order:
- Corptools ( link here )
- Assets on account
- skills on account
- some others i forget ATM
- zkill module ( link )
- Kills in time period
- Blacklist module ( link )
- users has no flags or has or has never had blacklisted char
Soon(tm) Wishlist
- Filter for PAP's per Time Period
- Please request any "filters" you feel are worthwhile.
Installation
Install
pip install allianceauth-securegroups
- edit your local.py amd add
'securegroups',
toINSTALLED_APPS
- run migrations
python myauth/manage.py migrate securegroups
- restart auth
supervisorctrl restart all
- create the update task by running
python myauth/manage.py setup_securegroup_task
- this will create a daily task to run all your smart group checks. you cam edit this schedule as you desire from withing the admin site.
Admin > Periodic Tasks > Secure Group Updater
- this will create a daily task to run all your smart group checks. you cam edit this schedule as you desire from withing the admin site.
Configuration
there are 4 steps to creating a smart group
- Create an Auth Group.
Admin > Group Management > Group > Add Group.
- WARNING: There is a bug in auth that will wipe andy "AuthGroup" Settings on first save, to get around this, Set your groups name then click save and continue, then edit the rest of the settings.
- Group Settings:
- The Smart Group will override the important ones.
- Hidden On
- Internal Off
- Public Off
- The rest of the settings are observed as per Alliance Auth's normal group behavior
- Open: Setting this will let anyone that passes the checks to join without a manager approval.
- States:
- Set states here to limit auto groups to specific states
- Having no states will make an autogroup run against the entire user base. ( this is not recommended )
- The Smart Group will override the important ones.
- Create your Smart Filters
- These will be in admin but can be under many apps that may provide a 3rd party filter
- Create the filter and add your options as needed.
- Set any Filters "Grace Periods",
Admin > Secure Groups > Smart Filters
- the default is 5 Days.
- 0 is no grace.
- after the elapsed time the user will be removed.
- Setup the Smart Group
Admin > Secure Groups > Smart Groups > Add Smart Group
- Group: pick group from step one
- Description Optional: to add to the group description in list
- Filters: pick your Smart Filters from Step 2
- Enabled: Turning this off Smart Groups dont show im the groups screen or run in any tasks
- Can Grace: Turning this off overrides all grace periods for Instant Kick during updates.
- Auto Group: Hides the group from the Secure Groups list, and will run every user in "member" States and constantly keep it in sync.
- Include In Updates: Setting this off will alow you to have a check om join and never again style group.
Notifications
- You cam send a simple update log to a discord webhook
- set these up in
Admin > Secure Groups > Group Update Webhooks > Add Group Update Webhook
- set these up in
- If you are using the AllianceAuth Discord Bot from Here users will be notified of pending removals and or removals from groups via DM's from the bot with an explanation. This requires no configuration.
Screenshots
Admin Setup of Smart Groups
User Group Selection
User Failed Checks
User Passed Checks
Discord Message Example
Issues
Please remember to report any Secure Groups related issues using the issues on this repository.
Contributing
Make sure you have signed the License Agreement by logging in at https://developers.eveonline.com before submitting any pull requests. All bug fixes or features must not include extra superfluous formatting changes.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for allianceauth-securegroups-0.0.1a5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3623e6124a34196db77812efa46c48e204fa0288a2a73c78b8d1db8b7320a8fe |
|
MD5 | 033e0f9223ac28124beb0fd263cd5503 |
|
BLAKE2b-256 | ca1c843f3f9058444784f645d170bf764b249a2e51b0608b4c4c40d692c15ce4 |