Skip to content

Commit

Permalink
docs: extra info in dev setup docs
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Oct 30, 2024
1 parent cee0726 commit 41bb93c
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/dev/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,19 @@

You must have Docker and Docker Compose installed first.

Docker install guide: https://docs.docker.com/engine/install/#other-linux-distros
Docker install guide: [https://docs.docker.com/engine/install][1]

Compose install guide: https://docs.docker.com/compose/install/#scenario-two-install-the-compose-plugin
Compose install guide: [https://docs.docker.com/compose/install][2]

## (Optional) Configure Google OAuth

- Create a new client ID and secret in your Google account for OAuth2.
- Set the redirect URL to your local frontend URL, e.g. `http://localhost:3040/auth`.

!!! note

This step is only required to use the frontend.

## Configure Your Dotenv

- There is an example `.env.example` file that can be copied:
Expand Down Expand Up @@ -48,4 +52,10 @@ DroneTM Frontend: [http://localhost:3040](http://localhost:3040)

Web ODM: [http://localhost:9900](http://localhost:9900)

- Default user: `admin`
- Default password: `password`

> Note the ports may be different if you changed them in the dotenv file.
[1]: https://docs.docker.com/engine/install/#other-linux-distros "Docker Install Guide"
[2]: https://docs.docker.com/compose/install/#scenario-two-install-the-compose-plugin "Docker Compose Install Guide"

0 comments on commit 41bb93c

Please sign in to comment.