Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Security guidance #192

Merged
merged 1 commit into from
May 14, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ The prototype kit provides a simple way to make interactive prototypes that look

Read the [project principles](docs/principles.md).

> You must protect user privacy at all times, even when using prototypes. Prototypes made with the kit look like GOV.UK, but do not have the same security provisions. Always make sure you are handling user data appropriately.
## Security

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra line break?

If you publish your prototypes online, they **must** be protected by a [username and password](docs/guides/publishing-on-heroku.md). This is to prevent members of the public finding prototypes and thinking they are real services.

You must protect user privacy at all times, even when using prototypes. Prototypes made with the kit look like GOV.UK, but do not have the same security provisions. Always make sure you are handling user data appropriately.

## Installation instructions

Expand Down
12 changes: 1 addition & 11 deletions docs/guides/publishing-on-heroku.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,7 @@ Replace `[name of your app]` with what you want to call your prototype.

## 5) Set a username and password

By default, prototypes made with the kit require a username and password to be used when deployed on Heroku.

Authentication is a good way to stop members of the public coming across your prototype by accident.
Prototypes made with the kit require a username and password when published online. This stops members of the public coming across your prototype by accident.

### To set username and password:

Expand All @@ -53,14 +51,6 @@ heroku config:set USERNAME=username_here
heroku config:set PASSWORD=password_here
```

### Turning off authentication:

If you want your prototype to be accessible on the web without needing a username and password, you can disable authentication.

```
heroku config:set USE_AUTH=false
```

## 6) Deploy your work

Make sure any changes you've made to your prototype have been committed to git.
Expand Down