Skip to content

Added details in README documentation #35

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.

Sign up for GitHub

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

Open
Jud-e wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −1
Open

Added details in README documentation #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,23 @@ It's for one person on a small server: one password, your data in your own Postg
<sub>The screenshots show the demo data: Jane Doe is made up.</sub>

## Run it on your computer
**Prerequisites**

All you need is [Docker Desktop](https://docs.docker.com/desktop/) on macOS or Windows, or Docker Engine with its Compose plugin on Linux, and about 2 GB of free memory. Run the commands in a terminal: macOS's Terminal, Linux, or WSL on Windows.
Before proceeding, ensure you have:

- **Docker:** [Docker Desktop](https://docs.docker.com/desktop/) on macOS or Windows, or Docker Engine with the Compose plugin on Linux.
- **OpenSSL:** Required to generate the PostgreSQL password and Dossier secret used in the installation commands.
- **Memory:** Approximately 2 GB of free RAM.

Verify that OpenSSL is available by running:

```bash
openssl version
```

If OpenSSL is not installed, install it using your operating system's package manager before proceeding.

On Windows, run the installation commands in WSL with OpenSSL available.

**1. Fetch the Compose file** into a folder of its own, and make the secrets Dossier needs:

Expand Down