From 01302381633ded22c341ff3a9c473ae4e447a2bd Mon Sep 17 00:00:00 2001
From: Vasily Gotovko <vasily.gotovko@gmail.com>
Date: Mon, 14 Jan 2013 10:59:16 +0300
Subject: [PATCH] Update init and Readme
---
README.md | 19 +++++++++++--------
init.rb | 5 +++--
2 files changed, 14 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 9006648..5b6c9bb 100644
--- a/README.md
+++ b/README.md
@@ -4,10 +4,10 @@ This plugin is used to authenticate in redmine through Google.
### Installation:
-Choose folder /plugins, make command
+Choose folder /plugins, make command
```console
-git clone git@gitlab.tsdv.net:redmine_omniauth_google.git
+git clone https://github.com/twinslash/redmine_omniauth_google.git
```
Restart rails server.
@@ -16,7 +16,7 @@ Restart rails server.
To make possible to authenticate via Google you must first to register application in Google
-* Go to the [registration](https://code.google.com/apis/console) link.
+* Go to the [registration](https://code.google.com/apis/console) link.
* Press "API Access" in left menu bar.
* Click the button "Create an OAuth 2.0 client ID".
* When registering specify application name, for example, Redmine Oauth Google.
@@ -29,22 +29,25 @@ The registrations is complete.
To make plugin to work properly
-* Login as administrator. In top menu select "Administration". Choose menu item Plugins. In plugins list choose "Redmine Omniauth Google plugin". Press "Configure".
-* Fill Сlient ID & Client Secret by corresponding values, obtained by Google.
+* Login as administrator. In top menu select "Administration". Choose menu item Plugins. In plugins list choose "Redmine Omniauth Google plugin". Press "Configure".
+* Fill Сlient ID & Client Secret by corresponding values, obtained by Google.
* Put the check "Oauth authentification", to make it possible to login through Google. Click Apply. Users can now to use apportunity to login via Google.
+Additionaly
+* Setup value Autologin in Settings on tab Authentification
+
### Other options
By default, all domains are allowed to authenticate through Google.
To limit login through Google for other domains you have to fill allowed domains in the text box field the "Allowed domains". Domains must be separated by newlines. For example:
```text
-onedomain.com
+onedomain.com
otherdomain.com
```
### Work process
-User goes to the login page(sign in). User clicks the button with Google image. The plugin redirects him to Google. User enters his the еmail & password from Google. Google redirect user back to plugins controller. Then the following cases:
+User goes to the login page (sign in) and clicks the button with Google image. The plugin redirects him to Google where user enters his the еmail & password from Google. Google redirects user back to plugins controller. Then the following cases:
1. If auto registration is enabled, user is redirected to 'my/page'
-2. In others cases user is redirected to 'login'.
\ No newline at end of file
+2. In other case user account is created and waited for admin activation
diff --git a/init.rb b/init.rb
index ecfc8cd..b4a1009 100644
--- a/init.rb
+++ b/init.rb
@@ -6,8 +6,9 @@ Redmine::Plugin.register :redmine_omniauth_google do
author 'Dmitry Kovalenok'
description 'This is a plugin for Redmine registration through google'
version '0.0.1'
- url 'http://gitlab.tsdv.net/redmine_omniauth_google'
- author_url 'https://tsdv.net/redmine/users/105'
+ url 'https://github.com/twinslash/redmine_omniauth_google'
+ author_url 'http://twinslash.com'
+
settings default: {
client_id: "",
client_secret: "",
--
GitLab