Skip to content

Commit

Permalink
Merge pull request #1486 from govuk-one-login/BAU/add-troubleshooting…
Browse files Browse the repository at this point in the history
…-to-readme

BAU: Add troubleshooting steps to README
  • Loading branch information
gtvj authored Mar 26, 2024
2 parents ad80aa6 + be664ce commit 9a27dd4
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,29 @@ You may need to install pre-commit for the script to work.
brew install pre-commit
```

## Troubleshooting the local run

### General steps to try first

If you're having problems running locally, try these steps first:

* Connect to the VPN
* Run `./shutdown.sh`
* Delete your Docker **Images** (you can do this via Docker Desktop or with `docker system prune --all`)
* Run `./startup.sh -lc` to do a cleanup before a local run
* Because things sometimes don't work first time round, a `touch src/server.ts` _while the server is running_ might help

### Getting past specific errors

<details>

<summary>`Error: secret option required for sessions`</summary>

1. stop the server with `./shutdown.sh`
2. run `./startup.sh -l` (there's no need for the -c flag)

</details>

## Other useful yarn commands

Remember to run these commands in the docker container itself.
Expand Down

0 comments on commit 9a27dd4

Please sign in to comment.