Skip to content

Commit

Permalink
Merge pull request #112 from mattkatz/main
Browse files Browse the repository at this point in the history
mention turning off https to prevent CSRF problems
  • Loading branch information
hughrun authored Nov 11, 2023
2 parents 69e00c4 + f3b2a27 commit 69594ff
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions content/contributing/install-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ cp .env.example .env
```
- In `.env`, change `DEBUG` to `true`
- Optionally, you can use a service like [ngrok](https://ngrok.com/) to set up a domain name, and set the `DOMAIN` variable in your `.env` file to the domain name generated by ngrok.
- Unless you want to set up your local machine to support https during development, you may want to set `USE_HTTPS=false`. If you try to register your admin account and see a message that `CSRF verification failed`, you should set this option.

- Set up nginx for development by copying the developer nginx configuration file (`nginx/development`) into a new file named `nginx/default.conf`:
``` { .sh }
Expand All @@ -27,10 +28,10 @@ cp nginx/development nginx/default.conf
- Start the application. In the command line, run:
``` { .sh }
./bw-dev build # Build the docker images
./bw-dev setup # Initialize the database and run migrations
./bw-dev setup # Initialize the database and run migrations. Note the ADMIN key at the end of this output. You'll need it to register the first admin user.
./bw-dev up # Start the docker containers
```
- Once the build is complete, you can access the instance at `http://localhost:1333` and create an admin user.
- Once the build is complete, you can access the instance at `http://localhost:1333` and create an admin user.

If you're curious: the `./bw-dev` command is a simple shell script runs various other tools: above, you could skip it and run `docker-compose build` or `docker-compose up` directly if you like. `./bw-dev` just collects them into one common place for convenience. Run it without arguments to get a list of available commands, read the [documentation page](/cli.html) for it, or open it up and look around to see exactly what each command is doing!

Expand Down

0 comments on commit 69594ff

Please sign in to comment.