Mathis/allianceauth
1
0
Fork 0
mirror of https://gitlab.com/allianceauth/allianceauth.git synced 2025-07-09 20:40:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

Clean up readme. Add rtfd badge.

Browse Source
This commit is contained in:
Adarnof 2017-01-06 01:10:41 -05:00
parent 9ad61c1f4c
commit e1ccd972e4
1 changed files with 25 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
README.md
View File

@ -2,74 +2,26 @@ Alliance Auth
============ ============
[![Join the chat at https://gitter.im/R4stl1n/allianceauth](https://badges.gitter.im/R4stl1n/allianceauth.svg)](https://gitter.im/R4stl1n/allianceauth?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Join the chat at https://gitter.im/R4stl1n/allianceauth](https://badges.gitter.im/R4stl1n/allianceauth.svg)](https://gitter.im/R4stl1n/allianceauth?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Documentation Status](https://readthedocs.org/projects/allianceauth/badge/?version=latest)](http://allianceauth.readthedocs.io/en/latest/?badge=latest)
Alliance service auth to help large scale alliances manage services. EVE service auth to help corps, alliances, and coalitions manage services.
Built for "The 99 Percent" open for anyone to use Built for "The 99 Percent" open for anyone to use.
[Documentation and Setup Guides](https://github.com/R4stl1n/allianceauth/wiki)
[Project Website](http://r4stl1n.github.io/allianceauth/)
[Old Dev Setup Guide] (http://r4stl1n.github.io/allianceauth/quicksetup.html)
[Old Production Setup Guide] (http://r4stl1n.github.io/allianceauth/fullsetup.html)
Join us in-game in the channel allianceauth for help and feature requests.
Special Thanks:
Thanks to Nikdoof, without his old auth implementation this project wouldn't be as far as it is now.
Note:
Please keep your admin account and normal accounts separate. If you are the admin only use
the admin account for admin stuff do not attempt to use it for your personal services.
Create a new normal account for this or things will break.
Requirements:
# Django Stuff #
django 1.10.1
django-bootstrap-form
django-celery
# Python Stuff #
python-mysql-connector
python-mysqld
python-passlib
python-evelink
python-openfire
python-xmpp
python-dnspython
# Needed Apps #
Rabbitmq server
Startup Instructions:
./bootstrap.sh (Sudo if needed)
./startup.sh
./shutdown.sh
Vagrant Instructions:
Copy the scripts to the root directory before running
Special Permissions In Admin: Special Permissions In Admin:
auth | user | group_management ( Access to add members to groups within the alliance ) auth | user | group_management ( Access to add members to groups within the alliance )
auth | user | jabber_broadcast ( Access to broadcast a message over jabber to own groups) auth | user | jabber_broadcast ( Access to broadcast a message over jabber to own groups )
auth | user | jabber_broadcast_all ( Can choose from all groups and the 'all' option when broadcasting) auth | user | jabber_broadcast_all ( Can choose from all groups and the 'all' option when broadcasting )
auth | user | corp_apis ( View APIs, and jackKnife, of all members in user's corp. ) auth | user | corp_apis ( View APIs, and jackKnife, of all members in user's corp. )
auth | user | alliance_apis ( View APIs, and jackKnife, of all member in user's alliance member corps. ) auth | user | alliance_apis ( View APIs, and jackKnife, of all member in user's alliance member corps. )
auth | user | timer_management ( Access to create and remove timers) auth | user | timer_management ( Access to create and remove timers )
auth | user | timer_view ( Access to timerboard to view timers) auth | user | timer_view ( Access to timerboard to view timers )
auth | user | srp_management ( Allows for an individual to create and remove srp fleets and fleet data) auth | user | srp_management ( Allows for an individual to create and remove srp fleets and fleet data )
auth | user | sigtracker_management ( Allows for an individual to create and remove signitures) auth | user | sigtracker_management ( Allows for an individual to create and remove signitures )
auth | user | sigtracker_view ( Allows for an individual view signitures) auth | user | sigtracker_view ( Allows for an individual view signitures )
auth | user | optimer_management ( Allows for an individual to create and remove fleet operations) auth | user | optimer_management ( Allows for an individual to create and remove fleet operations )
auth | user | optimer_view ( Allows for an individual view fleet operations) auth | user | optimer_view ( Allows for an individual view fleet operations )
auth | user | logging_notifications ( Generate notifications from logging) auth | user | logging_notifications ( Generate notifications from logging )
auth | user | human_resources ( View applications to user's corp ) auth | user | human_resources ( View applications to user's corp )
hrapplications | application | delete_application ( Can delete applications ) hrapplications | application | delete_application ( Can delete applications )
@ -78,14 +30,21 @@ Special Permissions In Admin:
hrapplications | application | view_apis ( Can see applicant's API keys ) hrapplications | application | view_apis ( Can see applicant's API keys )
hrapplications | applicationcomment | add_applicationcomment ( Can comment on applications ) hrapplications | applicationcomment | add_applicationcomment ( Can comment on applications )
Active Developers Vagrant Instructions:
Copy the scripts to the root directory before running
Active Developers:
Adarnof Adarnof
Kaezon Rio basraah
Mr McClain
Beta Testers/ Bug Fixers: Beta Testers/ Bug Fixers:
TrentBartlem ( Testing and Bug Fixes) TrentBartlem ( Testing and Bug Fixes )
IskFiend ( Bug Fixes and Server Configuration ) IskFiend ( Bug Fixes and Server Configuration )
Mr McClain (Bug Fixes and server configuration) Mr McClain (Bug Fixes and server configuration )
Special Thanks:
Thanks to Nikdoof, without his old auth implementation this project wouldn't be as far as it is now.