Skip to content

Commit

Permalink
update(unraid/daemon): improvements to unraid container documentation (
Browse files Browse the repository at this point in the history
…#18)

* Add info for daemon mode on unraid

adds a new "info" block to the daemon mode page calling out that daemon mode is set on unraid by default with a link to the unraid page

* update(container-image): adds instructions for post-arg and updated screenshot

* add(daemon/unraid): adds to the tip for changing cross-seeds post argument in unraid

* fix: adding `.yarn` to `.gitignore`

* update(daemon/unraid): adds unraid section

adds an unraid section to call it out specifically and links to the unraid install docs

* update(daemon/unraid): updates section for more clarity

---------

Co-authored-by: zakary <[email protected]>
  • Loading branch information
stickel and zakkarry authored Mar 1, 2024
1 parent e9387b3 commit 810b3cb
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 6 deletions.
7 changes: 4 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.frontmatter/database/pinnedItemsDb.json
.frontmatter/database/taxonomyDb.json
frontmatter.json
.yarn
.frontmatter/database/pinnedItemsDb.json
.frontmatter/database/taxonomyDb.json
frontmatter.json
9 changes: 9 additions & 0 deletions docs/basics/daemon.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ However, that's not very sustainable.
Below are a few ways you can set up `cross-seed daemon` to run on its own:

- [Docker](#docker)
- [Unraid](#unraid)
- [`systemd`](#systemd-linux)
- [`screen`](#screen)

Expand Down Expand Up @@ -95,6 +96,14 @@ docker restart cross-seed # Restart the daemon
docker logs cross-seed # view the logs
```

### Unraid

If you are running `cross-seed` on Unraid you should have installed the "Community App" from ambipro's repository, this is our official container.

Be default, the [container runs in daemon mode](../tutorials/unraid.md#automationscheduling) and no changes are needed.

We recommend you head over to the [Unraid Tutorial](../tutorials/unraid.md) for specifics and documentation for the container.

### `systemd` (Linux)

If you want to use `systemd` to run `cross-seed daemon` continuously, you can
Expand Down
12 changes: 9 additions & 3 deletions docs/tutorials/unraid.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ title: Unraid

## Installation

To install in unRAID, the easiest setup will be to use the
To install in Unraid, the easiest setup will be to use the
[Community Applications](https://forums.unraid.net/topic/38582-plug-in-community-applications/)
app (Apps section in the unRAID WebUI). Go to the **Apps** tab and search for `cross-seed`.
app (Apps section in the Unraid WebUI). Go to the **Apps** tab and search for `cross-seed`.
We have an official container now, which is under "ambipro's Repository". Click on the "Install"
button. This will take you to the template configuration.

Expand Down Expand Up @@ -54,7 +54,13 @@ Below is a screenshot of what your Docker container configuration might look
like. Now, you can try starting the Docker container and editing the resulting
configuration file in the next step.

![screenshot-cross-seed](https://user-images.githubusercontent.com/2813049/147599328-6032688e-45e4-43cf-87f6-a070829e1a1b.png)
![screenshot-cross-seed](https://github.com/cross-seed/cross-seed.org/assets/123845855/2ce0b912-e341-4622-b0a1-8dcd18557730)

:::tip

In the top right if you enable "Advanced View" it will reveal the `Post Argument` field, this can be changed from `daemon` to `search` (for example) to run the search command.

:::

You can start the container to create the config file path.

Expand Down

0 comments on commit 810b3cb

Please sign in to comment.