Skip to content

Commit c0f8fd1

Browse files
committed
Update installation guide for Dawarich on Unraid with version details and formatting fixes
1 parent d06c1fd commit c0f8fd1

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

docs/How_to_install_Dawarich_on_Unraid.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
>
66
> *Dawarich is still in beta and a rapidly evolving project, and some changes may break compatibility with older versions.*
77
8+
This guide is written for:
9+
10+
- Unraid OS 7.1.4
11+
- Dawarich 0.32.0
12+
813
## Installation methods: CA Templates vs. Docker Compose
914

1015
For Dawarich to run 4 docker containers are required:
@@ -17,9 +22,9 @@ For Dawarich to run 4 docker containers are required:
1722
> [!NOTE]
1823
> Some containers depend on others to be running first. Therefore this guide will follow this order: `dawarich_db` >> `dawarich_redis` >> `dawarich_app` >> `dawarich_sidekiq`.
1924
20-
[Usually](https://dawarich.app/docs/intro/) all 4 containers are created and started together using [Docker Compose](https://docs.docker.com/compose/). Unraid [does not support Docker Compose natively]((https://docs.unraid.net/unraid-os/using-unraid-to/run-docker-containers/overview/)). Instead, it uses its own implementation of `DockerMan` for managing Docker containers via [Community Applications (CA)](https://docs.unraid.net/unraid-os/using-unraid-to/run-docker-containers/community-applications/) plugin.
25+
[Usually](https://dawarich.app/docs/intro/) all 4 containers are created and started together using [Docker Compose](https://docs.docker.com/compose/). Unraid [does not support Docker Compose natively](https://docs.unraid.net/unraid-os/using-unraid-to/run-docker-containers/overview/). Instead, it uses its own implementation of `DockerMan` for managing Docker containers via [Community Applications (CA)](https://docs.unraid.net/unraid-os/using-unraid-to/run-docker-containers/community-applications/) plugin.
2126

22-
However, there is a [Docker Compose plugin](https://forums.unraid.net/topic/101521-docker-compose-plugin/) that can be used to [setup and run Dawarich using Docker Compose](https://github.com/Freika/dawarich/discussions/150). This method is not covered in this guide.
27+
However, there is a [Docker Compose Manager](https://forums.unraid.net/topic/114415-plugin-docker-compose-manager/) plugin that can be used to [setup and run Dawarich using Docker Compose](https://github.com/Freika/dawarich/discussions/150). This method is not covered in this guide.
2328

2429
*Feel free to contribute a PR if you want to add it.*
2530

@@ -55,7 +60,7 @@ The [docker-compose file](https://github.com/Freika/dawarich/blob/master/docker/
5560
By default user created networks are removed from Unraid when Docker is being restarted. This is done to prevent potential conflicts with the automatic generation of custom networks. If you want to use a user-defined bridge network for Dawarich containers, you need to change this behavior. Go to `Settings` -> `Docker` -> enable `Advanced View` and set `Preserve user defined networks` to `Yes`.
5661
Docker has to be stopped so that the setting can be changed.
5762

58-
> [!Warning]
63+
> [!WARNING]
5964
> Change this setting to preserve user defined networks, but it is the responsibility of the user to ensure these entries work correctly and are conflict free.
6065
6166
#### 2. Create the user-defined bridge network
@@ -133,7 +138,7 @@ Install the `dawarich_sidekiq` CA template from nwithan8's repository.
133138
- Set `Extra Parameters` to:
134139
135140
```bash
136-
--entrypoint=sidekiq-entrypoint.sh --restart=on-failure --health-cmd='pgrep -f sidekiq >/dev/null || exit 1' --health-interval=10s --health-retries=30 --health-start-period=30s --health-timeout=10s
141+
--entrypoint=sidekiq-entrypoint.sh --restart=on-failure --health-cmd='pgrep -f sidekiq >/dev/null || exit 1' --health-interval=10s --health-retries=30 --health-start-period=30s --health-timeout=10s
137142
```
138143
139144
> [!NOTE]

0 commit comments

Comments
 (0)