Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update unraid.md #2123

Merged
merged 3 commits into from
Jun 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 15 additions & 17 deletions docs/kometa/install/unraid.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Anywhere you see
something like this
```

That’s a command you’re going to type or paste into your unRAID Kometa `>_Console` terminal (Linux).
That’s a command you’re going to type or paste into your unRAID Kometa `>_Console`.

**IMPORTANT NOTES:**

Expand Down Expand Up @@ -90,9 +90,9 @@ Config Error: config not found at //config
```
We need to have a file called `config.yml` in the correct directory for Kometa to start. Open up an unRAID terminal session by clicking on the terminal icon `>_` in the top right of unRAID.

=== ":fontawesome-brands-linux: Linux"
=== ":fontawesome-brands-linux: unRAID"

[type this into your terminal]
[type this into your unRAID terminal]
```
mkdir /mnt/user/appdata/Kometa/config
touch /mnt/user/appdata/Kometa/config/config.yml
Expand All @@ -110,9 +110,9 @@ The default config file contains a reference to a directory that will show an er

We'll create it here so the error doesn't show up later.

=== ":fontawesome-brands-linux: Linux"
=== ":fontawesome-brands-linux: unRAID"

[type this into your terminal]
[type this into your Kometa `>_Console`]
```
mkdir config/assets
```
Expand All @@ -127,14 +127,14 @@ We'll create it here so the error doesn't show up later.

First, make a copy of the template:

=== ":fontawesome-brands-linux: Linux"
=== ":fontawesome-brands-linux: unRAID"

Get a copy of the template to edit [type this into your terminal]:
Get a copy of the template to edit [type this into your Kometa `>_Console`]:
```
curl -fLvo config/config.yml https://raw.githubusercontent.com/Kometa-Team/Kometa/master/config/config.yml.template
```

Now open the copy in an editor on the machine of your choice (Use Linux tab below for the Unraid Kometa `_>Console`):
Now open the copy in an editor on the machine of your choice:

{%
include-markdown "./wt/wt-editor.md"
Expand All @@ -146,7 +146,7 @@ Now open the copy in an editor on the machine of your choice (Use Linux tab belo

#### Testing the config file

Save the file (Use Linux tab below for the Unraid Kometa `_>Console`):
Save the file:

{%
include-markdown "./wt/wt-save.md"
Expand All @@ -155,7 +155,7 @@ Save the file (Use Linux tab below for the Unraid Kometa `_>Console`):
Then run the script again:

{%
include-markdown "./wt/wt-run-shell.md"
include-markdown "./wt/wt-run-console.md"
%}

{%
Expand All @@ -173,7 +173,7 @@ So let's run the script and see this happen:


{%
include-markdown "./wt/wt-run-shell.md"
include-markdown "./wt/wt-run-console.md"
%}

{%
Expand All @@ -182,13 +182,11 @@ So let's run the script and see this happen:

### Setting up a collection file and creating a sample collection.

(Use Linux tab below for the Unraid Kometa `_>Console`):

{%
include-markdown "./wt/wt-05-local-file.md"
%}

Save the file (Use Linux tab below for the Unraid Kometa `_>Console`):
Save the file:

{%
include-markdown "./wt/wt-save.md"
Expand All @@ -197,7 +195,7 @@ Save the file (Use Linux tab below for the Unraid Kometa `_>Console`):
Then run the script again:

{%
include-markdown "./wt/wt-run-shell.md"
include-markdown "./wt/wt-run-console.md"
%}

{%
Expand All @@ -210,7 +208,7 @@ Then run the script again:
include-markdown "./wt/wt-07-overlay-add.md"
%}

Save the file (Use Linux tab below for the Unraid Kometa `_>Console`):
Save the file:

{%
include-markdown "./wt/wt-save.md"
Expand All @@ -219,7 +217,7 @@ Save the file (Use Linux tab below for the Unraid Kometa `_>Console`):
Then run the script again:

{%
include-markdown "./wt/wt-run-shell.md"
include-markdown "./wt/wt-run-console.md"
%}

{%
Expand Down
8 changes: 8 additions & 0 deletions docs/kometa/install/wt/wt-05-local-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@ First, open the collection file [this will create the file if it doesn't already
notepad "config\Movies.yml"
```

=== ":fontawesome-brands-linux: unRAID"

[type this into your Kometa `>_Console`]

```
nano "config/Movies.yml"
```


In this file, add the following, exactly as it is shown here; remember that spacing is significant in YAML files:

Expand Down
12 changes: 12 additions & 0 deletions docs/kometa/install/wt/wt-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,18 @@
```
I’m using `notepad` here simply because it’s built into Windows. You can use any other text editor you wish, provided it saves files as PLAIN TEXT.

=== ":fontawesome-brands-linux: unRAID"

[type this into your Kometa `>_Console`]

```
nano config/config.yml
```

I’m using `nano` here mostly because it’s simpler than any other editor on Linux.


You can use any other text editor you wish, provided it saves files as PLAIN TEXT. `vi`, `emacs`, etc.


From here on in, when this walkthrough says "open the config file", I mean this `nano` or `notepad` command. **Don't copy the template again**.
5 changes: 5 additions & 0 deletions docs/kometa/install/wt/wt-run-console.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[type this into your Kometa `>_Console`]

```shell
python kometa.py -r
```
6 changes: 6 additions & 0 deletions docs/kometa/install/wt/wt-save.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,9 @@

If you're using `notepad`, type control-`s` or choose `Save` from the `File` menu.


=== ":fontawesome-brands-linux: unRAID"

If you're using `nano`, type control-`x`, then `y`, then the enter key.