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

More updates and tweaks #2441

Merged
merged 4 commits into from
Jan 12, 2025
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
11 changes: 10 additions & 1 deletion .github/.wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,10 @@ namespace
nas
natively
nitsua
NL
nocopy
Nokmål
NOSUCHLIBRARY
nl
nokmål
nosuchlibrary
Expand Down Expand Up @@ -328,8 +332,13 @@ xyz
yaml
yml
yourname
Yozora
YozoraXCII
YYYY
zaP
ZeroQI
yozora
yozoraxcii
yyyy
zap
zeroqi
zeroqi
81 changes: 36 additions & 45 deletions docs/kometa/install/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,27 @@ The great thing about Docker is that all the setup you'd have to do to run Komet

That means we can just jump right into running it. At the command prompt, type:

```
docker run --rm kometateam/kometa --run
=== ":fontawesome-brands-docker: latest"

```
```
docker run --rm kometateam/kometa --run
```

=== ":fontawesome-brands-docker: develop"

```
docker run --rm kometateam/kometa:develop --run
```

=== ":fontawesome-brands-docker: nightly"

```
docker run --rm kometateam/kometa:nightly --run
```

Use the branch reflecting the version of the wiki you are reading, as some functionality may be dependent on this. If you are reading the latest version of the wiki, use `latest` [or leave the tag off] as shown above. If you are reading the develop branch, use `develop`. If you are reading the nightly branch, use `nightly`.

This same thing holds for all future docker commands in this walkthrough.

This is going to fail with an error. That's expected.

Expand Down Expand Up @@ -195,27 +212,27 @@ This will display a full path:

=== ":fontawesome-brands-windows: Windows"

``` { .shell .no-copy }
``` { .no-copy }
C:\Users\YOURUSERNAME\kometa
```

Add "config" onto the end of that to get the host path to your config directory, for example:

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

```
``` { .shell .no-copy }
/home/YOURUSERNAME/kometa/config
```

=== ":fontawesome-brands-apple: macOS"

```
``` { .shell .no-copy }
/Users/YOURUSERNAME/kometa/config
```

=== ":fontawesome-brands-windows: Windows"

```
``` { .no-copy }
C:\Users\YOURUSERNAME\kometa\config
```

Expand All @@ -224,40 +241,38 @@ You'll need to add this to the docker command every time you run it, like this:

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

```
``` { .shell .no-copy }
docker run --rm -it -v "/home/YOURUSERNAME/kometa/config:/config:rw" kometateam/kometa
```

=== ":fontawesome-brands-apple: macOS"

```
``` { .shell .no-copy }
docker run --rm -it -v "/Users/YOURUSERNAME/kometa/config:/config:rw" kometateam/kometa
```

=== ":fontawesome-brands-windows: Windows"

```
``` { .no-copy }
docker run --rm -it -v "C:\Users\YOURUSERNAME\kometa\config:/config:rw" kometateam/kometa
```


If you run that command now it will display a similar error to before, but without all the image loading:
If you run that command now you should see something like this:

``` { .bash .no-copy }
$ docker run --rm -it -v "/Users/mroche/kometa/config:/config:rw" kometateam/kometa --run
Config Error: config not found at //config
Configuration File ('config.yml') has been downloaded from GitHub (Branch: 'master') and saved as '//config/config.yml'. Please update this file with your API keys and other required settings.
```

Note that I show the example path there.

<details>
<summary>Why did we create that `config' directory?</summary>

This was done so that from here on in the instructions match between this walkthrough and the [Local walkthrough](local.md).
This was done so that from here on in the instructions match between this walkthrough and the Local walkthrough, which insures consistency and reduces maintenance and potential error. This is not required; you can put the config file anywhere you like, but you will need to adjust the paths in the commands you run in this walkthrough to match where you put it. It's easier to have them match.

</details>


### Create a directory to quiet an error later

The default config file contains a reference to a directory that will show an error in the output later. That error can safely be ignored, but it causes some confusion with new users from time to time.
Expand All @@ -267,14 +282,14 @@ We'll create it here so the error doesn't show up later.
=== ":fontawesome-brands-linux: Linux"

[type this into your terminal]
```
``` { .shell }
mkdir config/assets
```

=== ":fontawesome-brands-apple: macOS"

[type this into your terminal]
```
``` { .shell }
mkdir config/assets
```

Expand All @@ -295,31 +310,7 @@ We'll create it here so the error doesn't show up later.

#### Editing the config template

First, make a copy of the template:

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

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

=== ":fontawesome-brands-apple: macOS"

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

=== ":fontawesome-brands-windows: Windows"

Go to [this URL](https://raw.githubusercontent.com/Kometa-Team/Kometa/master/config/config.yml.template) using a web browser; choose the "Save" command, then save the file at:
```
C:\Users\YOURUSERNAME\kometa\config\config.yml
```


Now open the copy in an editor:
Open the config file that Kometa created a moment ago in an editor:

{%
include-markdown "./wt/wt-editor.md"
Expand Down Expand Up @@ -443,7 +434,7 @@ Add the `develop` tag to the image name in your run command [or wherever you spe

```
docker run --rm -it -v "KOMETA_PATH_GOES_HERE:/config:rw" kometateam/kometa:develop --run
^^^^^^^
^^^^^^^
```

This may not work if you are not using the official image.
Expand All @@ -454,7 +445,7 @@ Add the `nightly` tag to the image name in your run command [or wherever you spe

```
docker run --rm -it -v "KOMETA_PATH_GOES_HERE:/config:rw" kometateam/kometa:nightly --run
^^^^^^^
^^^^^^^
```

This may not work if you are not using the official image.
Expand All @@ -465,5 +456,5 @@ Add the `latest` tag to the image name in your run command [or wherever you spec

```
docker run --rm -it -v "KOMETA_PATH_GOES_HERE:/config:rw" kometateam/kometa:latest --run
^^^^^^
^^^^^^
```
2 changes: 1 addition & 1 deletion docs/kometa/install/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ tmdb:
apikey: YOUR_TMDB_API_KEY
```

Change those four UPPER_CASE items to your actual values, and you're good to go. Running that file will create a couple of collections in your Plex library.
Change those four UPPER_CASE items to your actual values, and you're good to go. Running that file will create a couple of collections in your Plex movie library.

Kometa will *also* fill in that file with a lot of defaults, ready for you to modify and expand as you learn more about Kometa. It does this so that as new settings are added, the default values are inserted into your config file, ready for you to modify.

Expand Down
Binary file added docs/kometa/install/images/wt-tmdb-01.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/kometa/install/images/wt-tmdb-02.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/kometa/install/images/wt-tmdb-03.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading