From 669949aa8c000265d0d85d20f52aa3f44bd12383 Mon Sep 17 00:00:00 2001 From: Naoki Takezoe Date: Wed, 23 Dec 2015 23:30:10 +0900 Subject: [PATCH] Update docs --- doc/authenticator.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/authenticator.md b/doc/authenticator.md index d1c51b228..24347672c 100644 --- a/doc/authenticator.md +++ b/doc/authenticator.md @@ -3,7 +3,7 @@ Authentication in Controller GitBucket provides many [authenticators](https://github.com/gitbucket/gitbucket/blob/master/src/main/scala/gitbucket/core/util/Authenticator.scala) to access controlling in the controller. For example, in the case of `RepositoryViwerController`, -it references three authenticators, `ReadableUsersAuthenticator`, `ReferrerAuthenticator` and `CollaboratorsAuthenticator`: +it references three authenticators: `ReadableUsersAuthenticator`, `ReferrerAuthenticator` and `CollaboratorsAuthenticator`. ```scala class RepositoryViewerController extends RepositoryViewerControllerBase @@ -19,6 +19,8 @@ trait RepositoryViewerControllerBase extends ControllerBase { ... ``` +Authenticators provides a method to add guard to actions in the controller: + - `ReadableUsersAuthenticator` provides `readableUsersOnly` method - `ReferrerAuthenticator` provides `referrersOnly` method - `CollaboratorsAuthenticator` provides `collaboratorsOnly` method