Skip to content

yurijmi/omniauth-telegram

Repository files navigation

OmniAuth Telegram  Build Status Gem Version

Telegram Strategy for OmniAuth. You'll need to setup a bot for Telegram first. More info here

Installing

Add to your Gemfile:

gem 'omniauth-telegram'

Then bundle install.

Usage

OmniAuth::Strategies::Telegram is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: https://github.com/intridea/omniauth.

Here's a quick example, adding the middleware to a Rails app in config/initializers/omniauth.rb:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :telegram, ENV['BOT_NICKNAME'], ENV['BOT_SECRET']
end

Configuring

You can customise the button (more info on telegram's api website):

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :telegram, ENV['BOT_NICKNAME'], ENV['BOT_SECRET'],
    button_options: { 'request-access' => 'write' }
end

Supported Rubies

  • Ruby MRI (2.0+)

License

Copyright (c) 2018 by Yuri Mikhaylov

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

An OmniAuth strategy for Telegram

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •