diff options
Diffstat (limited to 'docs/versioned_docs/version-v0.23.1/02-Installation/01-docker.md')
| -rw-r--r-- | docs/versioned_docs/version-v0.23.1/02-Installation/01-docker.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/versioned_docs/version-v0.23.1/02-Installation/01-docker.md b/docs/versioned_docs/version-v0.23.1/02-Installation/01-docker.md index ab5e7123..c62fbaa5 100644 --- a/docs/versioned_docs/version-v0.23.1/02-Installation/01-docker.md +++ b/docs/versioned_docs/version-v0.23.1/02-Installation/01-docker.md @@ -11,18 +11,18 @@ 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: +For example you could make a new directory called "karakeep-app" with the following command: ``` -mkdir hoarder-app +mkdir karakeep-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) directly into your new directory. +Download the docker compose file provided [here](https://github.com/karakeep-app/karakeep/blob/main/docker/docker-compose.yml) directly into your new directory. ``` -wget https://raw.githubusercontent.com/hoarder-app/hoarder/main/docker/docker-compose.yml +wget https://raw.githubusercontent.com/karakeep-app/karakeep/main/docker/docker-compose.yml ``` ### 3. Populate the environment variables @@ -30,7 +30,7 @@ wget https://raw.githubusercontent.com/hoarder-app/hoarder/main/docker/docker-co To configure the app, create a `.env` file in the directory and add this minimal env file: ``` -HOARDER_VERSION=release +KARAKEEP_VERSION=release NEXTAUTH_SECRET=super_random_string MEILI_MASTER_KEY=another_random_string NEXTAUTH_URL=http://localhost:3000 @@ -38,7 +38,7 @@ NEXTAUTH_URL=http://localhost:3000 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). +Using `KARAKEEP_VERSION=release` will pull the latest stable version. You might want to pin the version instead to control the upgrades (e.g. `KARAKEEP_VERSION=0.10.0`). Check the latest versions [here](https://github.com/karakeep-app/karakeep/pkgs/container/karakeep). Persistent storage and the wiring between the different services is already taken care of in the docker compose file. @@ -93,7 +93,7 @@ Go to the [quick sharing page](/quick-sharing) to install the mobile apps and th ## Updating -Updating hoarder will depend on what you used for the `HOARDER_VERSION` env variable. +Updating karakeep will depend on what you used for the `KARAKEEP_VERSION` env variable. - If you pinned the app to a specific version, bump the version and re-run `docker compose up -d`. This should pull the new version for you. -- If you used `HOARDER_VERSION=release`, you'll need to force docker to pull the latest version by running `docker compose up --pull always -d`. +- If you used `KARAKEEP_VERSION=release`, you'll need to force docker to pull the latest version by running `docker compose up --pull always -d`. |