go/authboss
1
0
Fork 0
mirror of https://github.com/volatiletech/authboss.git synced 2024-11-24 08:42:17 +02:00
Code Issues Releases Activity

Add a few updates to documentation.

Browse Source
This commit is contained in:
Aaron 2015-02-22 22:27:45 -08:00
parent 001810bf7c
commit 73dcb5beb1
8 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -10,11 +10,10 @@ Each module can be turned on simply by importing it and the side-effects take ca
Name | Import Path | Description
---------------|-----------------------------------------------------------------------------------------------------|------------
Core | [gopkg.in/authboss.v0](https://github.com/go-authboss/authboss) | The necessities for authentication, module system etc.
Core | [gopkg.in/authboss.v0](https://github.com/go-authboss/authboss) | Support for the modular system, constants, helpers.
Register | [gopkg.in/authboss.v0/register](https://github.com/go-authboss/authboss/tree/master/register) | Provides a registration section for users.
Confirm | [gopkg.in/authboss.v0/confirm](https://github.com/go-authboss/authboss/tree/master/confirm) | Sends an e-mail verification before allowing users to log in.
Recover | [gopkg.in/authboss.v0/recover](https://github.com/go-authboss/authboss/tree/master/recover) | Allows for password resets via e-mail.
Remember | [gopkg.in/authboss.v0/remember](https://github.com/go-authboss/authboss/tree/master/remember) | Half-authed accounts using a generated token.
Remember | [gopkg.in/authboss.v0/remember](https://github.com/go-authboss/authboss/tree/master/remember) | Persisting login sessions past session expiry.
Lock | [gopkg.in/authboss.v0/lock](https://github.com/go-authboss/authboss/tree/master/lock) | Locks user accounts after N authentication failures in M time.
Expire | [gopkg.in/authboss.v0/expire](https://github.com/go-authboss/authboss/tree/master/expire) | Expires user sessions after a certain period of time.
Validate | [gopkg.in/authboss.v0/validate](https://github.com/go-authboss/authboss/tree/master/validate) | Username, Email and Password format validations.
Expire | [gopkg.in/authboss.v0/expire](https://github.com/go-authboss/authboss/tree/master/expire) | Expires user sessions after a certain period of inactivity.

4
auth/README.md
View File

@ -1,2 +1,4 @@
Auth
=========
=========
Auth authorizes users using credentials.

1
confirm/README.md
View File

@ -1,3 +1,4 @@
Confirm
=========
Confirm ensures registered users must confirm via e-mail before being an active user.

1
expire/README.md
View File

@ -1,3 +1,4 @@
Expire
=========
Expires user's active sessions if they have not taken action for a configurable amount of time.

1
lock/README.md
View File

@ -1,3 +1,4 @@
Lock
=========
Locks user accounts that have failed authentication a number of times.

1
recover/README.md
View File

@ -1,3 +1,4 @@
Recover
=========
Recover implements password recovery mechanisms.

1
register/README.md
View File

@ -1,3 +1,4 @@
Register
=========
Register allows users to register a new user account.

3
remember/README.md
View File

@ -1,3 +1,6 @@
Remember
=========
Remember module implements remebering users past the session cookie expiry. Also
ensures that remembered users are marked as "half-authed" to easily allow denying
of sensitive information until fully authed.