From 70ade2b4a0c94dae442d67cd7a54bd7200d73d8f Mon Sep 17 00:00:00 2001 From: bullmoose20 <12549033+bullmoose20@users.noreply.github.com> Date: Wed, 19 Jun 2024 09:30:14 -0400 Subject: [PATCH] [10] Update unraid install instructions (#2123) --- VERSION | 2 +- docs/kometa/install/unraid.md | 32 ++++++++++------------ docs/kometa/install/wt/wt-05-local-file.md | 8 ++++++ docs/kometa/install/wt/wt-editor.md | 12 ++++++++ docs/kometa/install/wt/wt-run-console.md | 5 ++++ docs/kometa/install/wt/wt-save.md | 6 ++++ 6 files changed, 47 insertions(+), 18 deletions(-) create mode 100644 docs/kometa/install/wt/wt-run-console.md diff --git a/VERSION b/VERSION index abdcb37e..0b2b8d98 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.0.2-build9 +2.0.2-build10 diff --git a/docs/kometa/install/unraid.md b/docs/kometa/install/unraid.md index 5c26508a..a0b4e688 100644 --- a/docs/kometa/install/unraid.md +++ b/docs/kometa/install/unraid.md @@ -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:** @@ -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 @@ -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 ``` @@ -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" @@ -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" @@ -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" %} {% @@ -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" %} {% @@ -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" @@ -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" %} {% @@ -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" @@ -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" %} {% diff --git a/docs/kometa/install/wt/wt-05-local-file.md b/docs/kometa/install/wt/wt-05-local-file.md index 92a24cbd..b00385cf 100644 --- a/docs/kometa/install/wt/wt-05-local-file.md +++ b/docs/kometa/install/wt/wt-05-local-file.md @@ -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: diff --git a/docs/kometa/install/wt/wt-editor.md b/docs/kometa/install/wt/wt-editor.md index ef3e4d83..a44feeb9 100644 --- a/docs/kometa/install/wt/wt-editor.md +++ b/docs/kometa/install/wt/wt-editor.md @@ -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**. diff --git a/docs/kometa/install/wt/wt-run-console.md b/docs/kometa/install/wt/wt-run-console.md new file mode 100644 index 00000000..f7178956 --- /dev/null +++ b/docs/kometa/install/wt/wt-run-console.md @@ -0,0 +1,5 @@ +[type this into your Kometa `>_Console`] + +```shell +python kometa.py -r +``` diff --git a/docs/kometa/install/wt/wt-save.md b/docs/kometa/install/wt/wt-save.md index f2756834..bffb2428 100644 --- a/docs/kometa/install/wt/wt-save.md +++ b/docs/kometa/install/wt/wt-save.md @@ -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. + +