Skip to content

Commit

Permalink
Merge pull request #8 from Cauatn/docs
Browse files Browse the repository at this point in the history
docs: nice message for windows users :)
  • Loading branch information
vieiralucas authored Sep 10, 2024
2 parents 7ba306b + 1de679e commit 4d90c29
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,19 @@ docker run -d \
briefercloud/briefer
```

When running on Windows' PowerShell, it might be necessary to add an extra ` to the end of each line instead of the `\`, like this:

```bash
# Run Briefer using Docker
docker run -d `
-p 3000:3000 `
-p 8080:8080 `
-v briefer_psql_data:/var/lib/postgresql/data `
-v briefer_jupyter_data:/home/jupyteruser `
-v briefer_briefer_data:/home/briefer `
briefercloud/briefer
```

These volumes are for Briefer to store its data, including its pages, dashboards, schedules, and users. If you want to remove Briefer's data, you can remove these volumes.

For more information on how to deploy Briefer in production, please refer to our [deployment guide](/docs/DEPLOYMENT.md).
Expand Down

0 comments on commit 4d90c29

Please sign in to comment.