diff --git a/mkdocs/docs/advanced.md b/mkdocs/docs/advanced.md index 5990cff..12b6de5 100644 --- a/mkdocs/docs/advanced.md +++ b/mkdocs/docs/advanced.md @@ -83,7 +83,7 @@ ES will not start, if the data is corrupted. So, stop all containers, delete eve **Tube Archivist** will apply mapping changes at application startup for certain versions. That usually is needed when changing how an existing field is indexed. This action should be seamless and automatic, but can leave your index in a messed up state if that process gets interrupted for any reason. Common reasons could be that if you artificially limit the memory to the container, disabling the OS to dynamically manage that, or if you don't have enough available storage on the ES volume, or if you interrupt that because of your impatience (don't do that). -In general the process is: +In general the mapping update process is as follows: 1. Compare existing mapping with predefined expected mapping 1. If that is identical, there is nothing to do diff --git a/mkdocs/docs/installation/docker-for-beginners.md b/mkdocs/docs/installation/docker-for-beginners.md index 5897950..a8ccc8b 100644 --- a/mkdocs/docs/installation/docker-for-beginners.md +++ b/mkdocs/docs/installation/docker-for-beginners.md @@ -109,7 +109,7 @@ This mounts the docker managed volume called `media` inside the container at `/y You'll run into this problem when using a bind mount for the ElasticSearch volume. See [here](https://github.com/tubearchivist/tubearchivist?tab=readme-ov-file#permissions-for-elasticsearch) with instructions how to fix that. -If you prefere, you can define where each volume should be stored on the file system by modifying the path **infront** of the `:`. Remember, you usually can't change the path _inside_ the container, only the path on the host system. +If you prefere, you can define where each volume should be stored on the file system by modifying the path **infront** of the `:`. Remember, you usually can't change the path _inside_ the container (right side of the `:`), only the path on the host system. If you define a bind mount, you can remove the docker managed volume definition from the `volumes` key at the bottom of the docker-compose file. @@ -156,7 +156,7 @@ Similar to volumes, the colon symbol `:` splits the network definition: - The right side of the `:` defines the port used _inside_ the container, aka `CONTAINER_PORT`. You _usually_ can't change that and you need to use the port as defined in the documentation. If a service allows you to customize that, you should see a mention in the docs as well. !!! info - You can't have more than one service using the same port. You'll see an error if you try to do that. The simplest way to rectify that is to change the `HOST_PORT` to something not in use, but keep the `CONTAINER_PORT` as is. + You can't have more than one service using the same port on your machine. You'll see an error if you try to do that. The simplest way to rectify that is to change the `HOST_PORT` to something not in use, but keep the `CONTAINER_PORT` as is. E.g.: `"8008:8000"` to use the port 8008 on the host. diff --git a/mkdocs/docs/installation/env-vars.md b/mkdocs/docs/installation/env-vars.md index cd1c2fb..683c601 100644 --- a/mkdocs/docs/installation/env-vars.md +++ b/mkdocs/docs/installation/env-vars.md @@ -89,7 +89,7 @@ Enable casting support. See [configuration/cast](../configuration/cast.md) for m This will disable authentication for static assets like your video mp4 files, subtitles and artwork. This might be required if you need to access the media files over the HTTP server but you are not able to pass authentication headers. !!! info - This is `read only` access and does not allow for deleting/modifying any media files. But it is still limit exposure or add additional protections if you enable that. + This is `read only` access and does not allow for deleting/modifying any media files. But it is still recommended limit exposure or add additional protections if you enable that. ## DJANGO_DEBUG Optional diff --git a/mkdocs/docs/playlists.md b/mkdocs/docs/playlists.md index 1a7d4b1..7da16d8 100644 --- a/mkdocs/docs/playlists.md +++ b/mkdocs/docs/playlists.md @@ -10,7 +10,7 @@ Playlists are organized in two different levels, similar to [Channels](channels. !!! note There is an overlap in functionality with [index playlists on channel](channels.md/#about): - - Subscribe to a playlist of the playlist contains videos from **mixed channels**. + - Subscribe to a playlist if the playlist contains videos from **various channels**. - Subscribe to a playlist if you only want to add **a few** playlists from a chanel. - Use [index playlists on channel](channels.md/#about) if you want to add **all** playlists of a channel. - Avoid subscribing to a playlist if the channel already monitors that playlist. diff --git a/mkdocs/docs/settings/scheduling.md b/mkdocs/docs/settings/scheduling.md index 77f1380..ef2106a 100644 --- a/mkdocs/docs/settings/scheduling.md +++ b/mkdocs/docs/settings/scheduling.md @@ -62,7 +62,7 @@ docker exec -it tubearchivist apprise -b "Hello from TA" ``` !!! note "Notes:" - - This will only send notifications when a task returns anything, e.g. if a [Rescan Subscriptions](#rescan-subscriptions) task doesn't find any new videos to add, a notification will *not* be sent. + - This will only send notifications when a task returns anything, e.g. if a [Rescan Subscriptions](#rescan-subscriptions) task doesn't find any new videos to add, **no** notification will will be sent. - Due to the fact that Apprise is running inside a container, [desktop notifications](https://github.com/caronc/apprise/wiki#desktop-notification-services) will not work. - Notification services that require additional libraries that what is provided by Apprise are not supported. If you really *need* to use services that require additional libraries, you can use Apprise in a standalone server as a proxy or manually install what you need in the container. - You can add mutiple notifications for the same task by saving and selecting the same task multiple times.