Social login support for Solidus. Solidus Social handles authorization, account creation and association through third-party services. Currently Facebook, Github and Google OAuth2 are available out of the box.
Add solidus_social to your Gemfile:
gem 'solidus_social'Bundle your dependencies and run the installation generator:
bundle
bundle exec rails g solidus_social:install
bundle exec rails db:migrateThis will install a new initializer config/initializers/solidus_social.rb into
your project that allows you to setup the services you want configured for your app.
Optional: By default the login path will be '/users/auth/:provider'. If you
want something else, configure it in config/initializers/solidus_social.rb.
Login as an admin user and navigate to Configuration > Social Authentication Methods
Click "New Authentication Method" and choose one of your configured providers.
You MUST restart your application after configuring or updating an authentication method.
Facebook, Github and Google OAuth2 are supported out of the box but, you will need to register your application with each of the sites you want to use.
When setting up development applications, keep in mind that most services do
not support localhost for your URL/domain. You will need to us a regular
domain (i.e. domain.tld, hostname.local) or an IP addresses (127.0.0.1).
Make sure you specifity the right IP address.
- Name the app and agree to the terms.
- Fill out the capcha.
- Under the "Web Site" tab enter:
- Site URL:
http://yourhostname.local:3000for development andhttp://your-site.comfor production - Site domain:
yourhostname.localandyour-site.comrespectively
Github / Applications / Register a new OAuth application
- Name the application.
- Fill in the details
- Main URL:
http://yourhostname.local:3000for development andhttp://your-site.comfor production - Callback URL:
http://yourhostname.local:3000for development andhttp://your-site.comfor production
- Click Create.
Google / APIs / Credentials/ Create Credential
- In the APIs and Services dashboard, visit 'Credentials' on the side, then select 'Create Credentials' and 'Oauth client ID'.
- Name the Application, select "Web Application" as a type.
- Under "Authorized redirect URIs", add your site (example:
http://localhost:3000/users/auth/google_oauth2/callback)
More info: https://developers.google.com/identity/protocols/OAuth2
Other OAuth providers are supported, given that there is an OmniAuth strategy for them. (If there isn't, you can write one.)
-
Add
gem "omniauth-linkedin"to your Gemfile and runbundle install. -
In
config/initializers/solidus_social.rbadd and initialize a new provider for SolidusSocial:config.providers = { # The configuration key has to match your omniauth strategy. linkedin: { api_key: ENV['LINKEDIN_API_KEY'], api_secret: ENV['LINKEDIN_API_SECRET'], }, # More providers here
-
Activate your provider as usual.
-
Do one of the following:
- Override the
spree/users/socialview to render OAuth links to display your LinkedIn link. - Include in your CSS a definition for
.icon-spree-linkedin-circledand an embedded icon font for LinkedIn from [Fontello][14] (the way existing icons for Facebook etc are implemented). You can also override CSS classes for other providers,.icon-spree-<provider>-circled, to use different font icons or classic background images, without having to override views.
- Override the
-
Add
gem "omniauth-apple"to your Gemfile and runbundle install. -
In
config/initializers/solidus_social.rbadd and initialize a new provider for SolidusSocial:config.providers = { apple: { icon: 'fa-apple', title: 'Apple' }, # More providers here
add its configuration after
SolidusSocial.init_providersline:Devise.setup do |config| # The configuration key has to match your omniauth strategy. config.omniauth :apple, ENV['APPLE_CLIENT_ID'], '', scope: 'email', team_id: ENV['APPLE_TEAM_ID'], key_id: ENV['APPLE_KEY_ID'], pem: ENV['APPLE_PRIVATE_KEY'].gsub('\n', "\n") end
Notice: APPLE_PRIVATE_KEY should consist from one-line p8-file content, like this
'\n-----BEGIN PRIVATE KEY-----\nsecret\n-----END PRIVATE KEY-----\n'
API documentation is available [on RubyDoc.info][15].
See corresponding guidelines.
First bundle your dependencies, then run rake. rake will default to building the dummy app if it does not exist, then it will run specs, and Rubocop static code analysis. The dummy app can be regenerated by using rake test_app.
bundle
bin/rakeWhen testing your application's integration with this extension you may use its factories. Simply add this require statement to your spec_helper:
require 'solidus_social/factories'Your new extension version can be released using gem-release like this:
bundle exec gem bump -v VERSION --tag --push --remote upstream && gem releaseCopyright (c) 2014 John Dyer and contributors, released under the New BSD License
![dependabot-preview[bot] avatar](https://avatars.githubusercontent.com/in/2141?v=4 "dependabot-preview[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent