akkounts/README.md

1.7 KiB

Akkounts

This app allows Kosmos/LDAP users to manage their accounts, including credentials, invites, donations, etc..

Features

  • Log in with existing LDAP account
  • Reset account password by providing both username and email address
  • Reset account password when logged in, via reset email
  • Log in with admin permissions
  • View LDAP users as admin
  • List my donations
  • Invite new users from your account
  • Sign up for a new account via invite
  • Sign up for a new account by donating upfront
  • Sign up for a new account via proving contributions (via cryptographic signature)
  • ...

Planned features are not at all a complete or static list, of course. Suggestions and pull requests welcome!

Development

Rails app

Installing dependencies:

bundle install
yarn install

Setting up local database (SQLite):

bundle exec rails db:create
bundle exec rails db:migrate

Running the dev server:

bundle exec rails server

Running all specs:

bundle exec rspec

LDAP server

TODO make it easy to run a local Kosmos LDAP server for development, without manual LDIF imports etc. (or provide a staging instance)

Documentation

Testing

LDAP / Auth

License

GNU Affero General Public License v3.0