whitehall image


government content publishing for gov.uk

From GitHub

Publishes government content on GOV.UK

Back-end stack

Front-end stack


Readme from GitHub


Whitehall is deployed in two modes:

Live examples (public facing APIs)

Live examples (public facing frontend)

CSV Previews

Fields of Operation

Government Information

World Information

Running the Application

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

Traditionally, the two sides of Whitehall are available on different domains in development, which reflect their counterparts in production:

While this usually results in different routing behaviour, in development all routes can be accessed from either domain, although the redirect behaviour may differ.


  • Govspeak A variation of Markdown used throughout whitehall as the general publishing format

Technical documentation

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

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

Running the test suite

# run all the test suites
bundle exec rake

Javascript unit tests can also be run separately:

# run all the JavaScript tests
bundle exec rake jasmine

Further documentation

See the [docs/](docs/) directory.

  • [CSS](docs/css.md)
  • [Edition workflow](docs/edition_workflow.md)
  • [How to publish a finder in whitehall](docs/finders.md)
  • [Internationalisation](docs/internationalisation_guide.md)
  • [JavaScript](docs/javascript.md)
  • [Search setup guide](docs/search_setup_guide.md)
  • [Timestamps](docs/timestamps.md)
  • [Troubleshooting](docs/troubleshooting.md)
  • [Adding a data migration](db/data_migration/README.md)


[MIT License](LICENCE)