signon

(★ 97)

Single sign-on service for GOV.UK

File Explorer

Download Latest Version (.zip)

- - actionlint.yml
  - build-image-from-pr.yml
  - ci.yml
  - copy-pr-template-to-dependabot-prs.yml
  - deploy.yml
  - pact-verify.yml
  - release.yml
- dependabot.yml
- pull_request_template.md
- - accounts_controller.rb
  - api_users_controller.rb
  - application_controller.rb
  - authorisations_controller.rb
  - batch_invitation_permissions_controller.rb
  - batch_invitations_controller.rb
  - confirmations_controller.rb
  - doorkeeper_applications_controller.rb
  - healthcheck_controller.rb
  - invitations_controller.rb
  - oauth_users_controller.rb
  - organisations_controller.rb
  - passwords_controller.rb
  - root_controller.rb
  - sessions_controller.rb
  - signin_required_authorizations_controller.rb
  - supported_permissions_controller.rb
  - suspensions_controller.rb
  - two_step_verification_exemptions_controller.rb
  - user_research_recruitment_controller.rb
  - users_controller.rb
- - account_helper.rb
  - api_users_helper.rb
  - application_access_helper.rb
  - application_helper.rb
  - application_permissions_helper.rb
  - application_table_helper.rb
  - batch_invitations_helper.rb
  - event_log_helper.rb
  - navigation_items_helper.rb
  - organisation_helper.rb
  - root_helper.rb
  - two_step_verification_helper.rb
  - users_helper.rb
  - users_with_access_helper.rb
- - application_job.rb
  - batch_invitation_job.rb
  - permission_updater.rb
  - push_user_updates_job.rb
  - reauth_enforcer.rb
- - .gitkeep
  - application_mailer.rb
  - mailer_helper.rb
  - noisy_batch_invitation.rb
  - user_mailer.rb
- - .gitkeep
  - api_user.rb
  - application_record.rb
  - batch_invitation.rb
  - batch_invitation_application_permission.rb
  - batch_invitation_user.rb
  - event_log.rb
  - legacy_users_filter.rb
  - log_entry.rb
  - old_password.rb
  - organisation.rb
  - reject_non_governmental_email_addresses_validator.rb
  - supported_permission.rb
  - suspension.rb
  - two_step_verification_exemption.rb
  - user.rb
  - user_agent.rb
  - user_application_permission.rb
  - user_update_permission_builder.rb
  - users_filter.rb
- - account_page_policy.rb
  - api_user_policy.rb
  - application_policy.rb
  - authorisation_policy.rb
  - base_policy.rb
  - batch_invitation_policy.rb
  - organisation_policy.rb
  - supported_permission_policy.rb
  - user_policy.rb
- - user_export_presenter.rb
  - user_o_auth_presenter.rb
- - users_with_access.rb
- - user_update.rb
- bootsnap
- brakeman
- byebug
- coderay
- convert_to_should_syntax
- dartsass
- dev
- erb
- expgen
- htmldiff
- httparty
- irb
- jsonpath
- kramdown
- ldiff
- listen
- minitest
- nokogiri
- pact
- pact-broker
- pact-mock-service
- pact-stub-service
- pactflow
- prometheus_exporter
- pry
- puma
- pumactl
- racc
- rackup
- rails
- rake
- rdoc
- restclient
- ri
- rotp
- rougify
- rspec
- rubocop
- ruby-parse
- ruby-rewrite
- sass
- setup
- sidekiq
- sidekiqmon
- sprockets
- term_cdiff
- term_colortab
- term_decolor
- term_display
- term_mandel
- term_plasma
- term_snow
- thor
- uuid
- yarn
- - development.rb
  - production.rb
  - test.rb
- - application_controller_renderer.rb
  - assets.rb
  - backtrace_silencers.rb
  - content_security_policy.rb
  - cookies_serializer.rb
  - dartsass.rb
  - date_formats.rb
  - devise.rb
  - doorkeeper.rb
  - doorkeeper_scopes.rb
  - filter_parameter_logging.rb
  - govuk_error.rb
  - i18n.rb
  - inflections.rb
  - load_model_enhancements.rb
  - mime_types.rb
  - permissions_policy.rb
  - prometheus.rb
  - rack_attack.rb
  - session_store.rb
  - wrap_parameters.rb
- - department_specific.en.yml
  - devise.en.yml
  - devise.security_extension.en.yml
  - devise_invitable.en.yml
  - doorkeeper.en.yml
  - en.yml
- application.rb
- boot.rb
- brakeman.ignore
- database.yml
- devise.yml
- environment.rb
- puma.rb
- routes.rb
- schedule.rb
- secrets.yml
- sidekiq.yml
- unicorn.rb
- - 20240228080000_reencrypt_user_otp_keys.rb
  - 20240423105028_remove_user_application_permissions_with_deleted_supported_permission.rb
  - 20240429130154_remove_user_permissions_with_deleted_permission.rb
  - 20240809112119_index_event_logs_columns.rb
  - 20241001140623_rename_supported_permission_delegatable_column.rb
- schema.rb
- seeds.rb
- - adr-001-pass-anonymised-user-ids-to-publishing-apps-and-analytics.md
- - signon-sign-in-from-whitehall-publisher.svg
- access_and_permissions.md
- api.md
- environment-variables.md
- mass_password_reset.md
- oauth.md
- troubleshooting.md
- usage.md
- - .gitkeep
- - global_prometheus_collector.rb
- - bulk_organisation_updater.rb
- - client.rb
- - zendesk_to_signon.rb
- - admin.rb
  - base.rb
  - normal.rb
  - organisation_admin.rb
  - super_organisation_admin.rb
  - superadmin.rb
- - .gitkeep
  - access_tokens.rake
  - applications.rake
  - assets.rake
  - data_hygiene.rake
  - event_log.rake
  - jasmine.rake
  - lint.rake
  - oauth_access_records.rake
  - organisation_mappings.rake
  - organisations.rake
  - permissions.rake
  - sync_kubernetes_secrets.rake
  - users.rake
- abilities.rb
- code_verifier.rb
- exception_handler.rb
- expired_not_signed_in_user_deleter.rb
- expired_oauth_access_records_deleter.rb
- failure_app.rb
- inactive_users_suspender.rb
- inactive_users_suspension_reminder.rb
- inactive_users_suspension_reminder_mailing_list.rb
- organisations_fetcher.rb
- roles.rb
- signin_permission_granter.rb
- sso_push_client.rb
- sso_push_credential.rb
- sso_push_error.rb
- supported_permission_parameter_filter.rb
- unsupported_permission_error.rb
- user_parameter_sanitiser.rb
- user_permission_migrator.rb
- volatile_lock.rb
- .gitkeep
- import_user_organisation_membership_from_whitehall
- make_oauth_work_in_dev
- minitest-ci
- - jasmine-browser.json
- - .gitkeep
  - api_users_controller_test.rb
  - authorisations_controller_test.rb
  - batch_invitation_permissions_controller_test.rb
  - batch_invitations_controller_test.rb
  - confirmations_controller_test.rb
  - doorkeeper_applications_controller_test.rb
  - invitations_controller_test.rb
  - oauth_users_controller_test.rb
  - organisations_controller_test.rb
  - passwords_controller_test.rb
  - root_controller_test.rb
  - sessions_controller_test.rb
  - signin_required_authorizations_controller_test.rb
  - supported_permissions_controller_test.rb
  - suspensions_controller_test.rb
  - two_step_verification_controller_test.rb
  - two_step_verification_exemptions_controller_test.rb
  - user_research_recruitment_controller_test.rb
  - users_controller_test.rb
- - batch_invitation.rb
  - batch_invitation_application_permission.rb
  - batch_invitation_user.rb
  - event_log.rb
  - oauth_access_grants.rb
  - oauth_access_tokens.rb
  - oauth_applications.rb
  - organisation.rb
  - supported_permission.rb
  - two_step_verification_exemption.rb
  - user_application_permission.rb
  - users.rb
- - users.csv
  - users_with_orgs.csv
- - account_helper_test.rb
  - application_access_helper_test.rb
  - application_helper_test.rb
  - application_permissions_helper_test.rb
  - application_table_helper_test.rb
  - batch_invitations_helper_test.rb
  - organisation_helper_test.rb
  - root_helper_test.rb
  - two_step_verification_helper_test.rb
  - users_helper_test.rb
  - users_with_access_helper_test.rb
- - api_authentication_test.rb
  - api_users_test.rb
  - authorise_application_test.rb
  - batch_inviting_users_test.rb
  - cookies_security_test.rb
  - dashboard_test.rb
  - doorkeeper_integration_test.rb
  - email_change_test.rb
  - event_log_creation_test.rb
  - inviting_users_test.rb
  - mandate_2sv_for_organisation_test.rb
  - password_reset_test.rb
  - session_timeout_test.rb
  - sign_in_test.rb
  - sign_out_test.rb
  - two_step_verification_prompt_test.rb
  - two_step_verification_test.rb
  - updating_permissions_for_apps_with_many_permissions_test.rb
  - user_agent_test.rb
  - user_locking_test.rb
  - user_research_recruitment_banner_test.rb
  - user_suspension_test.rb
  - volatile_lock_test.rb
- - permission_updater_test.rb
  - push_user_updates_job_test.rb
  - reauth_enforcer_test.rb
- - code_verifier_test.rb
  - expired_not_signed_in_user_deleter_test.rb
  - expired_oauth_access_records_deleter_test.rb
  - inactive_users_suspender_test.rb
  - inactive_users_suspension_reminder_mailing_list_test.rb
  - inactive_users_suspension_reminder_test.rb
  - organisations_fetcher_test.rb
  - roles_test.rb
  - signin_permission_granter_test.rb
  - sso_push_client_test.rb
  - sso_push_credential_test.rb
  - sso_push_error_test.rb
  - user_parameter_sanitiser_test.rb
  - user_permission_migrator_test.rb
- - .gitkeep
  - api_user_test.rb
  - batch_invitation_test.rb
  - batch_invitation_user_test.rb
  - event_log_test.rb
  - legacy_users_filter_test.rb
  - noisy_batch_invitation_test.rb
  - organisation_test.rb
  - supported_permission_test.rb
  - suspension_test.rb
  - two_step_verification_exemption_test.rb
  - user_agent_test.rb
  - user_application_permission_test.rb
  - user_export_presenter_test.rb
  - user_mailer_content_test.rb
  - user_mailer_test.rb
  - user_o_auth_presenter_test.rb
  - user_test.rb
  - user_update_permission_builder_test.rb
  - users_filter_test.rb
- - account_page_policy_test.rb
  - api_user_policy_test.rb
  - application_policy_test.rb
  - authorisation_policy_test.rb
  - batch_invitation_policy_test.rb
  - organisation_policy_scope_test.rb
  - organisation_policy_test.rb
  - supported_permission_policy_scope_test.rb
  - user_policy_scope_test.rb
  - user_policy_test.rb
- - pact_helper.rb
- - user_update_test.rb
- - autocomplete_helper.rb
  - confirmation_token_helpers.rb
  - editing_users_helpers.rb
  - email_helpers.rb
  - flash_helpers.rb
  - granting_access_helpers.rb
  - managing_two_sv_helpers.rb
  - password_helpers.rb
  - policy_helpers.rb
  - pundit_helpers.rb
  - removing_access_helpers.rb
  - token_auth_helpers.rb
  - updating_permissions_helpers.rb
  - user_account_helpers.rb
  - user_helpers.rb
- test_helper.rb
- - .gitkeep
.agignore
.dockerignore
.gitignore
.govuk_dependabot_merger.yml
.node-version
.rubocop.yml
.ruby-version
config.ru
Dockerfile
Gemfile
Gemfile.lock
LICENCE
package.json
Procfile
Procfile.dev
Rakefile
README.md
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/alphagov/signon

Downloads the entire project code from GitHub to your computer.

cd signon

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -t signon .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 signon

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Ruby

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Ruby Ruby is required to use the bundle command.

bundle exec rake

Type this command into your terminal and run it.

✅ If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).

Pulled directly from this repo's README.

signon

File Explorer

# Installation Guide

2. Docker

3. Node.js

4. Ruby

Today's picks

Was this content helpful?

Recent Feedback

signon

File Explorer

# Installation Guide

2. Docker

3. Node.js

4. Ruby

Today's picks

Was this content helpful?

Recent Feedback

Download README