Skip to content

Latest commit

 

History

History
69 lines (42 loc) · 1.7 KB

README.md

File metadata and controls

69 lines (42 loc) · 1.7 KB
Raw

Decidim::IdcatMobil

User registration and login through IdCat Mòbil, an authentication method that uses OAuth 2.0 protocol. IdCat mòbil is an identity validator from VÀLid (Validador d'Identitats del Consorci AOC).

User verification via IdCat Mòbil was started but is incomplete.

Installation

Add this line to your application's Gemfile:

gem 'decidim-idcat_mobil'

And then execute:

bundle install

Usage

To use it you have to first configure the omniauth-idcat_mobil.

omniauth-idcat_mobil configuration

IdCat mòbil will be available as a configurable OAuth2 strategy. Check how to configure the strategy in Decidim's related documentation. The summary is that you have to edit your config/secrets.rb and simply enable the strategy:

  omniauth:
    idcat_mobil:
      enabled: true
      icon_path: media/images/idcat_mobil-icon.svg

Remember to set IDCAT_MOBIL_CLIENT_ID, IDCAT_MOBIL_CLIENT_SECRET and IDCAT_MOBIL_SITE_URL environment variables.

Refer to omniauth-idcat_mobil gem for further documentation.

TODO

  • User Verification development has to be finished.

Contributing

See Decidim.

Run tests

Create a dummy app in your application (if not present):

bundle exec rake decidim:generate_external_test_app

And run tests:

bundle exec rspec spec/

License

The Department d'Exteriors of Generalitat de Catalunya makes this gem available as open source under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE.

Authored by CodiTramuntana.