https://github.com/alphagov/signon

Single sign-on service for GOV.UK
https://github.com/alphagov/signon

container govuk

Last synced: about 2 months ago
JSON representation

Single sign-on service for GOV.UK

• Host: GitHub
• URL: https://github.com/alphagov/signon
• Owner: alphagov
• License: mit
• Created: 2012-04-04T13:23:55.000Z (over 12 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T11:58:43.000Z (5 months ago)
• Last Synced: 2024-04-12T18:43:34.415Z (5 months ago)
• Topics: container, govuk
• Language: Ruby
• Homepage: https://docs.publishing.service.gov.uk/apps/signon.html
• Size: 8.86 MB
• Stars: 91
• Watchers: 92
• Forks: 37
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Signon

Signon is a centralised OAuth2 based single sign-on provider for GDS services that provides username/password and 2-step verification.

## Technical documentation

[Devise] is used to provide username password sign-in, and [Doorkeeper] as an OAuth 2 provider. Details of our interpretation of OAuth are provided in [an accompanying document][auth].

This is a Ruby on Rails app, and should follow [our Rails app conventions][conventions].

You can use the [GOV.UK Docker environment][govuk-docker] to run the application and its tests with all the necessary dependencies. Follow the [usage instructions][docker-usage] to get started.

**Use GOV.UK Docker to run any commands that follow.**

### Running the test suite

```sh

bundle exec rake

```

## Further documentation

- [Usage documentation]

- [Environment variables]

- [Mass password reset]

- [Troubleshooting]

## Licence

[MIT License](LICENCE)

[integration]: https://signon.integration.publishing.service.gov.uk

[conventions]: https://docs.publishing.service.gov.uk/manual/conventions-for-rails-applications.html

[govuk-docker]: https://github.com/alphagov/govuk-docker

[docker-usage]: https://github.com/alphagov/govuk-docker#usage

[Devise]: https://github.com/plataformatec/devise

[Doorkeeper]: https://github.com/applicake/doorkeeper

[auth]: docs/oauth.md

[Usage documentation]: docs/usage.md

[Environment variables]: docs/environment-variables.md

[Mass password reset]: docs/mass_password_reset.md

[Troubleshooting]: docs/troubleshooting.md