Skip to content

Commit

Permalink
docs: Minor language changes to the docker installation docs (#615)
Browse files Browse the repository at this point in the history
Changed some language in the docker installation documentation that I found confusing when I tried to follow the steps.
  • Loading branch information
LightningMarshal authored Dec 22, 2024
1 parent 0f4177a commit bfa62ee
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/docs/02-Installation/01-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,17 @@

Create a new directory to host the compose file and env variables.

This is where you’ll place the `docker-compose.yml` file from the next step and the environment variables.

For example you could make a new directory called "hoarder-app" with the following command:
```
mkdir hoarder-app
```


### 2. Download the compose file

Download the docker compose file provided [here](https://github.com/hoarder-app/hoarder/blob/main/docker/docker-compose.yml).
Download the docker compose file provided [here](https://github.com/hoarder-app/hoarder/blob/main/docker/docker-compose.yml) directly into your new directory.

```
wget https://raw.githubusercontent.com/hoarder-app/hoarder/main/docker/docker-compose.yml
Expand All @@ -28,7 +36,7 @@ MEILI_MASTER_KEY=another_random_string
NEXTAUTH_URL=http://localhost:3000
```

You **should** change the random strings. You can use `openssl rand -base64 36` to generate the random strings. You should also change the `NEXTAUTH_URL` variable to point to your server address.
You **should** change the random strings. You can use `openssl rand -base64 36` in a seperate terminal window to generate the random strings. You should also change the `NEXTAUTH_URL` variable to point to your server address.

Using `HOARDER_VERSION=release` will pull the latest stable version. You might want to pin the version instead to control the upgrades (e.g. `HOARDER_VERSION=0.10.0`). Check the latest versions [here](https://github.com/hoarder-app/hoarder/pkgs/container/hoarder-web).

Expand Down

0 comments on commit bfa62ee

Please sign in to comment.