mirror of
https://github.com/volatiletech/authboss.git
synced 2024-11-28 08:58:38 +02:00
Clean up URLs
This commit is contained in:
parent
064b53490b
commit
58c1136c31
@ -13,5 +13,5 @@ the type in the attribute map matches what's in the struct before assignment.
|
|||||||
## 2015-04-01 Refactor for Multi-tenancy
|
## 2015-04-01 Refactor for Multi-tenancy
|
||||||
This breaking change allows multiple sites running off the same code base to each use different configurations of Authboss. To migrate
|
This breaking change allows multiple sites running off the same code base to each use different configurations of Authboss. To migrate
|
||||||
your code simply use authboss.New() to get an instance of Authboss and all the old things that used to be in the authboss package are
|
your code simply use authboss.New() to get an instance of Authboss and all the old things that used to be in the authboss package are
|
||||||
now there. See [this commit to the sample](https://github.com/go-authboss/authboss-sample/commit/eea55fc3b03855d4e9fb63577d72ce8ff0cd4079)
|
now there. See [this commit to the sample](https://github.com/volatiletech/authboss-sample/commit/eea55fc3b03855d4e9fb63577d72ce8ff0cd4079)
|
||||||
to see precisely how to make these changes.
|
to see precisely how to make these changes.
|
||||||
|
60
README.md
60
README.md
@ -4,8 +4,8 @@ Authboss
|
|||||||
========
|
========
|
||||||
|
|
||||||
[![GoDoc](https://godoc.org/github.com/volatiletech/authboss?status.svg)](https://godoc.org/github.com/volatiletech/authboss)
|
[![GoDoc](https://godoc.org/github.com/volatiletech/authboss?status.svg)](https://godoc.org/github.com/volatiletech/authboss)
|
||||||
[![Build Status](https://circleci.com/gh/go-authboss/authboss.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/go-authboss/authboss)
|
[![Build Status](https://circleci.com/gh/volatiletech/authboss.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/volatiletech/authboss)
|
||||||
[![Coverage Status](https://coveralls.io/repos/go-authboss/authboss/badge.svg?branch=master)](https://coveralls.io/r/go-authboss/authboss?branch=master)
|
[![Coverage Status](https://coveralls.io/repos/volatiletech/authboss/badge.svg?branch=master)](https://coveralls.io/r/volatiletech/authboss?branch=master)
|
||||||
[![Mail](https://img.shields.io/badge/mail%20list-authboss-lightgrey.svg)](https://groups.google.com/a/volatile.tech/forum/#!forum/authboss)
|
[![Mail](https://img.shields.io/badge/mail%20list-authboss-lightgrey.svg)](https://groups.google.com/a/volatile.tech/forum/#!forum/authboss)
|
||||||
|
|
||||||
Authboss is a modular authentication system for the web. It tries to remove as much boilerplate and "hard things" as possible so that
|
Authboss is a modular authentication system for the web. It tries to remove as much boilerplate and "hard things" as possible so that
|
||||||
@ -45,13 +45,13 @@ use them in your app.
|
|||||||
|
|
||||||
Name | Import Path | Description
|
Name | Import Path | Description
|
||||||
---------------|-----------------------------------------------------------------------------------------------------|------------
|
---------------|-----------------------------------------------------------------------------------------------------|------------
|
||||||
Auth | [github.com/volatiletech/authboss/auth](https://github.com/go-authboss/authboss/tree/master/auth) | Provides database password authentication for users.
|
Auth | [github.com/volatiletech/authboss/auth](https://github.com/volatiletech/authboss/tree/master/auth) | Provides database password authentication for users.
|
||||||
Confirm | [github.com/volatiletech/authboss/confirm](https://github.com/go-authboss/authboss/tree/master/confirm) | Sends an e-mail verification before allowing users to log in.
|
Confirm | [github.com/volatiletech/authboss/confirm](https://github.com/volatiletech/authboss/tree/master/confirm) | Sends an e-mail verification before allowing users to log in.
|
||||||
Lock | [github.com/volatiletech/authboss/lock](https://github.com/go-authboss/authboss/tree/master/lock) | Locks user accounts after N authentication failures in M time.
|
Lock | [github.com/volatiletech/authboss/lock](https://github.com/volatiletech/authboss/tree/master/lock) | Locks user accounts after N authentication failures in M time.
|
||||||
OAuth2 | [github.com/volatiletech/authboss/oauth2](https://github.com/go-authboss/authboss/tree/master/oauth2) | Provides oauth2 authentication for users.
|
OAuth2 | [github.com/volatiletech/authboss/oauth2](https://github.com/volatiletech/authboss/tree/master/oauth2) | Provides oauth2 authentication for users.
|
||||||
Recover | [github.com/volatiletech/authboss/recover](https://github.com/go-authboss/authboss/tree/master/recover) | Allows for password resets via e-mail.
|
Recover | [github.com/volatiletech/authboss/recover](https://github.com/volatiletech/authboss/tree/master/recover) | Allows for password resets via e-mail.
|
||||||
Register | [github.com/volatiletech/authboss/register](https://github.com/go-authboss/authboss/tree/master/register) | User-initiated account creation.
|
Register | [github.com/volatiletech/authboss/register](https://github.com/volatiletech/authboss/tree/master/register) | User-initiated account creation.
|
||||||
Remember | [github.com/volatiletech/authboss/remember](https://github.com/go-authboss/authboss/tree/master/remember) | Persisting login sessions past session cookie expiry.
|
Remember | [github.com/volatiletech/authboss/remember](https://github.com/volatiletech/authboss/tree/master/remember) | Persisting login sessions past session cookie expiry.
|
||||||
|
|
||||||
Getting Started
|
Getting Started
|
||||||
===============
|
===============
|
||||||
@ -120,7 +120,7 @@ Once you've got this code set up, it's time to implement the use cases you care
|
|||||||
<a name="how_to"></a>How To
|
<a name="how_to"></a>How To
|
||||||
============================
|
============================
|
||||||
|
|
||||||
There is a full implementation of authboss at: https://github.com/go-authboss/authboss-sample
|
There is a full implementation of authboss at: https://github.com/volatiletech/authboss-sample
|
||||||
This sample implements a blog with all of the modules with exception that it doesn't use the expiry middleware
|
This sample implements a blog with all of the modules with exception that it doesn't use the expiry middleware
|
||||||
since it conflicts with the remember module.
|
since it conflicts with the remember module.
|
||||||
|
|
||||||
@ -172,7 +172,7 @@ if err != nil {
|
|||||||
|
|
||||||
## <a name="auth"></a>User Authentication via Password
|
## <a name="auth"></a>User Authentication via Password
|
||||||
**Requirements:**
|
**Requirements:**
|
||||||
- Auth module ([github.com/volatiletech/authboss/auth](https://github.com/go-authboss/authboss/tree/master/auth))
|
- Auth module ([github.com/volatiletech/authboss/auth](https://github.com/volatiletech/authboss/tree/master/auth))
|
||||||
- [Storer](#storers)
|
- [Storer](#storers)
|
||||||
- [Session Storer](#client_storers)
|
- [Session Storer](#client_storers)
|
||||||
- [Views](#views)
|
- [Views](#views)
|
||||||
@ -189,7 +189,7 @@ Another link is created for a logout. Simply link/redirect the user to this page
|
|||||||
|
|
||||||
## <a name="oauth2"></a> User Authentication via OAuth2
|
## <a name="oauth2"></a> User Authentication via OAuth2
|
||||||
**Requirements:**
|
**Requirements:**
|
||||||
- OAuth2 module ([github.com/volatiletech/authboss/oauth2](https://github.com/go-authboss/authboss/tree/master/oauth2))
|
- OAuth2 module ([github.com/volatiletech/authboss/oauth2](https://github.com/volatiletech/authboss/tree/master/oauth2))
|
||||||
- [OAuth2Storer](#storers)
|
- [OAuth2Storer](#storers)
|
||||||
- OAuth2Providers
|
- OAuth2Providers
|
||||||
- [Session and Cookie Storers](#client_storers)
|
- [Session and Cookie Storers](#client_storers)
|
||||||
@ -221,12 +221,12 @@ uri := `/authboss_mount_path/oauth2/google?` + params.Encode()
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Examples:**
|
**Examples:**
|
||||||
- [OAuth2Providers](https://github.com/go-authboss/authboss-sample/blob/master/blog.go#L57)
|
- [OAuth2Providers](https://github.com/volatiletech/authboss-sample/blob/master/blog.go#L57)
|
||||||
- [Writing a custom OAuth2Provider Callback](https://github.com/go-authboss/authboss/blob/master/oauth2/providers.go#L29)
|
- [Writing a custom OAuth2Provider Callback](https://github.com/volatiletech/authboss/blob/master/oauth2/providers.go#L29)
|
||||||
|
|
||||||
## <a name="register"></a> User Registration
|
## <a name="register"></a> User Registration
|
||||||
**Requirements:**
|
**Requirements:**
|
||||||
- Register module ([github.com/volatiletech/authboss/register](https://github.com/go-authboss/authboss/tree/master/register))
|
- Register module ([github.com/volatiletech/authboss/register](https://github.com/volatiletech/authboss/tree/master/register))
|
||||||
- [RegisterStorer](#storers)
|
- [RegisterStorer](#storers)
|
||||||
- [Session Storer](#client_storers)
|
- [Session Storer](#client_storers)
|
||||||
- [Views](#views)
|
- [Views](#views)
|
||||||
@ -245,8 +245,8 @@ See also: [Validation](#validation)
|
|||||||
|
|
||||||
## <a name="confirm"></a> Confirming Registrations
|
## <a name="confirm"></a> Confirming Registrations
|
||||||
**Requirements:**
|
**Requirements:**
|
||||||
- Register module ([github.com/volatiletech/authboss/register](https://github.com/go-authboss/authboss/tree/master/register))
|
- Register module ([github.com/volatiletech/authboss/register](https://github.com/volatiletech/authboss/tree/master/register))
|
||||||
- Confirm module ([github.com/volatiletech/authboss/confirm](https://github.com/go-authboss/authboss/tree/master/confirm))
|
- Confirm module ([github.com/volatiletech/authboss/confirm](https://github.com/volatiletech/authboss/tree/master/confirm))
|
||||||
- [RegisterStorer](#storers)
|
- [RegisterStorer](#storers)
|
||||||
- [Session and Cookie Storers](#client_storers)
|
- [Session and Cookie Storers](#client_storers)
|
||||||
- [Views](#views)
|
- [Views](#views)
|
||||||
@ -264,7 +264,7 @@ logged in. The default for this property is set to false.
|
|||||||
|
|
||||||
## <a name="recover"></a> Password Recovery
|
## <a name="recover"></a> Password Recovery
|
||||||
**Requirements:**
|
**Requirements:**
|
||||||
- Recover module ([github.com/volatiletech/authboss/recover](https://github.com/go-authboss/authboss/tree/master/recover))
|
- Recover module ([github.com/volatiletech/authboss/recover](https://github.com/volatiletech/authboss/tree/master/recover))
|
||||||
- [RecoverStorer](#storers)
|
- [RecoverStorer](#storers)
|
||||||
- [Session Storer](#client_storers)
|
- [Session Storer](#client_storers)
|
||||||
- [Views](#views)
|
- [Views](#views)
|
||||||
@ -281,7 +281,7 @@ to true, the user will also be automatically logged in. The default for this pro
|
|||||||
|
|
||||||
## <a name="remember"></a> Remember Me (persistent login)
|
## <a name="remember"></a> Remember Me (persistent login)
|
||||||
**Requirements:**
|
**Requirements:**
|
||||||
- Remember module ([github.com/volatiletech/authboss/remember](https://github.com/go-authboss/authboss/tree/master/remember))
|
- Remember module ([github.com/volatiletech/authboss/remember](https://github.com/volatiletech/authboss/tree/master/remember))
|
||||||
- [RememberStorer](#storers)
|
- [RememberStorer](#storers)
|
||||||
- [Session and Cookie Storers](#client_storers)
|
- [Session and Cookie Storers](#client_storers)
|
||||||
|
|
||||||
@ -309,7 +309,7 @@ to pages with sensitive information if this value is true in the session, and fo
|
|||||||
|
|
||||||
## <a name="lock"></a> Locking Accounts for Authentication Failures
|
## <a name="lock"></a> Locking Accounts for Authentication Failures
|
||||||
**Requirements:**
|
**Requirements:**
|
||||||
- Lock module ([github.com/volatiletech/authboss/lock](https://github.com/go-authboss/authboss/tree/master/lock))
|
- Lock module ([github.com/volatiletech/authboss/lock](https://github.com/volatiletech/authboss/tree/master/lock))
|
||||||
- [Storer](#storers)
|
- [Storer](#storers)
|
||||||
|
|
||||||
**Storage Requirements:**
|
**Storage Requirements:**
|
||||||
@ -398,7 +398,7 @@ Each of the store interfaces provides some amount of functionality to a module.
|
|||||||
Most of these interfaces simply do look ups on the user based on different field. Some of them like the RememberStorer are more special in their
|
Most of these interfaces simply do look ups on the user based on different field. Some of them like the RememberStorer are more special in their
|
||||||
functionality.
|
functionality.
|
||||||
|
|
||||||
You can see an example here: [Blog Storer](https://github.com/go-authboss/authboss-sample/blob/master/storer.go).
|
You can see an example here: [Blog Storer](https://github.com/volatiletech/authboss-sample/blob/master/storer.go).
|
||||||
This storer implements all 6 of the Storer Interfaces. If you don't use as many modules as the blog, you don't need to implement all of these methods.
|
This storer implements all 6 of the Storer Interfaces. If you don't use as many modules as the blog, you don't need to implement all of these methods.
|
||||||
|
|
||||||
Most of the methods return an (interface{}, error), the interface{} user struct that is described below. In cases where the queries produce no values (ie no user found),
|
Most of the methods return an (interface{}, error), the interface{} user struct that is described below. In cases where the queries produce no values (ie no user found),
|
||||||
@ -430,7 +430,7 @@ extract it's data into authboss.Attributes, which is used for all authboss opera
|
|||||||
|
|
||||||
#### Examples
|
#### Examples
|
||||||
|
|
||||||
- [Storer & OAuth2Storer combined](https://github.com/go-authboss/authboss-sample/blob/master/storer.go)
|
- [Storer & OAuth2Storer combined](https://github.com/volatiletech/authboss-sample/blob/master/storer.go)
|
||||||
|
|
||||||
## <a name="client_storers"></a> Implementing Client Storers
|
## <a name="client_storers"></a> Implementing Client Storers
|
||||||
|
|
||||||
@ -446,8 +446,8 @@ Keep in mind that these need not be only cookie-based, any storage medium that c
|
|||||||
can be used. You could insert a redis backend here if you like that approach better than just cookies.
|
can be used. You could insert a redis backend here if you like that approach better than just cookies.
|
||||||
|
|
||||||
**Examples:**
|
**Examples:**
|
||||||
- [Session Storer](https://github.com/go-authboss/authboss-sample/blob/master/session_storer.go)
|
- [Session Storer](https://github.com/volatiletech/authboss-sample/blob/master/session_storer.go)
|
||||||
- [Cookie Storer](https://github.com/go-authboss/authboss-sample/blob/master/cookie_storer.go)
|
- [Cookie Storer](https://github.com/volatiletech/authboss-sample/blob/master/cookie_storer.go)
|
||||||
|
|
||||||
## <a name="views"></a> Views
|
## <a name="views"></a> Views
|
||||||
The view system in Authboss uses Go templates with the concepts of layout/views to render HTML to the user. It uses the authboss.HTMLData type
|
The view system in Authboss uses Go templates with the concepts of layout/views to render HTML to the user. It uses the authboss.HTMLData type
|
||||||
@ -492,11 +492,11 @@ Confirmation Email (txt) | confirm_email.txt.tpl
|
|||||||
Recover Email (html) | recover_email.html.tpl
|
Recover Email (html) | recover_email.html.tpl
|
||||||
Recover Email (txt) | recover_email.txt.tpl
|
Recover Email (txt) | recover_email.txt.tpl
|
||||||
|
|
||||||
[Example Layout Configuration](https://github.com/go-authboss/authboss-sample/blob/master/blog.go#L47)
|
[Example Layout Configuration](https://github.com/volatiletech/authboss-sample/blob/master/blog.go#L47)
|
||||||
|
|
||||||
**Example Overriden Templates:**
|
**Example Overriden Templates:**
|
||||||
- [Layout](https://github.com/go-authboss/authboss-sample/blob/master/views/layout.html.tpl)
|
- [Layout](https://github.com/volatiletech/authboss-sample/blob/master/views/layout.html.tpl)
|
||||||
- [Login](https://github.com/go-authboss/authboss-sample/blob/master/ab_views/login.html.tpl)
|
- [Login](https://github.com/volatiletech/authboss-sample/blob/master/ab_views/login.html.tpl)
|
||||||
- [Recover](https://github.com/go-authboss/authboss-sample/blob/master/ab_views/recover.html.tpl)
|
- [Recover](https://github.com/volatiletech/authboss-sample/blob/master/ab_views/recover.html.tpl)
|
||||||
- [Recover New Password](https://github.com/go-authboss/authboss-sample/blob/master/ab_views/recover_complete.html.tpl)
|
- [Recover New Password](https://github.com/volatiletech/authboss-sample/blob/master/ab_views/recover_complete.html.tpl)
|
||||||
- [Register](https://github.com/go-authboss/authboss-sample/blob/master/ab_views/register.html.tpl)
|
- [Register](https://github.com/volatiletech/authboss-sample/blob/master/ab_views/register.html.tpl)
|
||||||
|
Loading…
Reference in New Issue
Block a user