diff --git a/README.rdoc b/README.rdoc index c7fd4fad2131a344f6944243b56a60b1e5fccbf8..73fa9bc158bf7feb89425a9caf4c968d6d3c49b6 100644 --- a/README.rdoc +++ b/README.rdoc @@ -1,3 +1,24 @@ -= redmine_omniauth_google + This plugin is used to authenticate in redmine through google. -Description goes here + Installation: +Choose folder /plugins, make command git clone git@gitlab.tsdv.net:redmine_omniauth_google.git. Restart rails server. + + To make possible to authenticate via google you must first to register application in +Google. Go to the link https://code.google.com/apis/console and register plugin. +When registering specify application name, for example, Redmine Oauth Google. +In section "Your site or hostname" choose mode http, in the text input box enter +your domain, for example, yourdomain.com. Select (more options). +In section "Authorized Redirect URIs" in the text box enter http://yourdomain/oauth_google_callback. Press the button "Create client ID". +The registrations is complete. + + 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. + + 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: + 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