diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/01-intro.md | 2 | ||||
| -rw-r--r-- | docs/docs/02-Installation/01-docker.md | 6 | ||||
| -rw-r--r-- | docs/docs/02-Installation/02-unraid.md | 2 | ||||
| -rw-r--r-- | docs/docs/03-configuration.md | 2 | ||||
| -rw-r--r-- | docs/docusaurus.config.ts | 8 |
5 files changed, 10 insertions, 10 deletions
diff --git a/docs/docs/01-intro.md b/docs/docs/01-intro.md index ae9d414c..a51093ad 100644 --- a/docs/docs/01-intro.md +++ b/docs/docs/01-intro.md @@ -6,7 +6,7 @@ slug: / Hoarder is an open source "Bookmark Everything" app that uses AI for automatically tagging the content you throw at it. The app is built with self-hosting as a first class citizen. - + ## Features diff --git a/docs/docs/02-Installation/01-docker.md b/docs/docs/02-Installation/01-docker.md index 0fa47ad4..89fa6538 100644 --- a/docs/docs/02-Installation/01-docker.md +++ b/docs/docs/02-Installation/01-docker.md @@ -11,10 +11,10 @@ Create a new directory to host the compose file and env variables. ### 2. Download the compose file -Download the docker compose file provided [here](https://github.com/MohamedBassem/hoarder-app/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). ``` -wget https://raw.githubusercontent.com/MohamedBassem/hoarder-app/main/docker/docker-compose.yml +wget https://raw.githubusercontent.com/hoarder-app/hoarder/main/docker/docker-compose.yml ``` ### 3. Populate the environment variables @@ -30,7 +30,7 @@ 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. -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/MohamedBassem/hoarder-app/pkgs/container/hoarder-web). +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). Persistent storage and the wiring between the different services is already taken care of in the docker compose file. diff --git a/docs/docs/02-Installation/02-unraid.md b/docs/docs/02-Installation/02-unraid.md index 1502e125..b879f900 100644 --- a/docs/docs/02-Installation/02-unraid.md +++ b/docs/docs/02-Installation/02-unraid.md @@ -2,7 +2,7 @@ ## Docker Compose Manager Plugin (Recommended) -You can use [Docker Compose Manager](https://forums.unraid.net/topic/114415-plugin-docker-compose-manager/) plugin to deploy Hoarder using the official docker compose file provided [here](https://github.com/MohamedBassem/hoarder-app/blob/main/docker/docker-compose.yml). After creating the stack, you'll need to setup some env variables similar to that from the docker compose installation docs [here](/Installation/docker#3-populate-the-environment-variables). +You can use [Docker Compose Manager](https://forums.unraid.net/topic/114415-plugin-docker-compose-manager/) plugin to deploy Hoarder using the official docker compose file provided [here](https://github.com/hoarder-app/hoarder/blob/main/docker/docker-compose.yml). After creating the stack, you'll need to setup some env variables similar to that from the docker compose installation docs [here](/Installation/docker#3-populate-the-environment-variables). ## Community Apps diff --git a/docs/docs/03-configuration.md b/docs/docs/03-configuration.md index f777731f..fc9e70db 100644 --- a/docs/docs/03-configuration.md +++ b/docs/docs/03-configuration.md @@ -1,6 +1,6 @@ # Configuration -The app is mainly configured by environment variables. All the used environment variables are listed in [packages/shared/config.ts](https://github.com/MohamedBassem/hoarder-app/blob/main/packages/shared/config.ts). The most important ones are: +The app is mainly configured by environment variables. All the used environment variables are listed in [packages/shared/config.ts](https://github.com/hoarder-app/hoarder/blob/main/packages/shared/config.ts). The most important ones are: | Name | Required | Default | Description | | ------------------------- | ------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index b4562440..7780ba0a 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -36,7 +36,7 @@ const config: Config = { docs: { sidebarPath: './sidebars.ts', editUrl: - 'https://github.com/MohamedBassem/hoarder-app/tree/main/docs/', + 'https://github.com/hoarder-app/hoarder/tree/main/docs/', routeBasePath: "/", }, blog: false, @@ -64,7 +64,7 @@ const config: Config = { position: 'right', }, { - href: 'https://github.com/MohamedBassem/hoarder-app', + href: 'https://github.com/hoarder-app/hoarder', label: 'GitHub', position: 'right', }, @@ -87,7 +87,7 @@ const config: Config = { items: [ { label: 'GitHub', - href: 'https://github.com/MohamedBassem/hoarder-app', + href: 'https://github.com/hoarder-app/hoarder', }, ], }, @@ -100,7 +100,7 @@ const config: Config = { }, { label: 'GitHub', - href: 'https://github.com/MohamedBassem/hoarder-app', + href: 'https://github.com/hoarder-app/hoarder', }, { label: 'Demo', |