mirror of
https://github.com/tubearchivist/docs.git
synced 2024-11-22 03:40:14 +00:00
fix some links and indenting
This commit is contained in:
parent
7f024e5462
commit
a67a62a063
@ -8,6 +8,7 @@ The channels are organized on two different levels, similar to the [playlists](p
|
|||||||
|
|
||||||
## Channels Overview
|
## Channels Overview
|
||||||
Accessible at `/channel/` of your Tube Archivist, the **Overview Page** shows a list of all channels you have indexed.
|
Accessible at `/channel/` of your Tube Archivist, the **Overview Page** shows a list of all channels you have indexed.
|
||||||
|
|
||||||
- You can filter that list to show or hide subscribed channels with the toggle. Clicking on the channel banner or the channel name will direct you to the *Channel Detail Page*.
|
- You can filter that list to show or hide subscribed channels with the toggle. Clicking on the channel banner or the channel name will direct you to the *Channel Detail Page*.
|
||||||
- If you are subscribed to a channel an *Unsubscribe* button will show, if you aren't subscribed, a *Subscribe* button will show instead.
|
- If you are subscribed to a channel an *Unsubscribe* button will show, if you aren't subscribed, a *Subscribe* button will show instead.
|
||||||
|
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
!!! note
|
!!! note
|
||||||
These are beginner's guides/installation instructions for additional platforms generously provided by users of these platforms. When in doubt, verify the details with the [project README](https://github.com/tubearchivist/tubearchivist#installing-and-updating). If you see any issues here while using these instructions, please contribute.
|
These are beginner's guides/installation instructions for additional platforms generously provided by users of these platforms. When in doubt, verify the details with the [project README](https://github.com/tubearchivist/tubearchivist#installing). If you see any issues here while using these instructions, please contribute.
|
||||||
|
|
||||||
There is a Helm Chart available at [https://github.com/insuusvenerati/helm-charts](https://github.com/insuusvenerati/helm-charts). Mostly self-explanatory but feel free to ask questions in the discord / subreddit.
|
There is a Helm Chart available at [https://github.com/insuusvenerati/helm-charts](https://github.com/insuusvenerati/helm-charts). Mostly self-explanatory but feel free to ask questions in the discord / subreddit.
|
@ -1,9 +1,9 @@
|
|||||||
!!! note
|
!!! note
|
||||||
These are beginner's guides/installation instructions for additional platforms generously provided by users of these platforms. When in doubt, verify the details with the [project README](https://github.com/tubearchivist/tubearchivist#installing-and-updating). If you see any issues here while using these instructions, please contribute.
|
These are beginner's guides/installation instructions for additional platforms generously provided by users of these platforms. When in doubt, verify the details with the [project README](https://github.com/tubearchivist/tubearchivist#installing). If you see any issues here while using these instructions, please contribute.
|
||||||
|
|
||||||
Podman handles container hostname resolving slightly differently than docker, so you need to make a few changes to the `docker-compose.yml` to get up and running.
|
Podman handles container hostname resolving slightly differently than docker, so you need to make a few changes to the `docker-compose.yml` to get up and running.
|
||||||
|
|
||||||
### Follow the installation instructions from the [README](https://github.com/tubearchivist/tubearchivist#installing-and-updating), with a few additional changes to the `docker-compose.yml`.
|
### Follow the installation instructions from the [README](https://github.com/tubearchivist/tubearchivist#installing), with a few additional changes to the `docker-compose.yml`.
|
||||||
|
|
||||||
Edit these additional changes to the `docker-compose.yml`:
|
Edit these additional changes to the `docker-compose.yml`:
|
||||||
|
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
!!! note
|
!!! note
|
||||||
These are beginner's guides/installation instructions for additional platforms generously provided by users of these platforms. When in doubt, verify the details with the [project README](https://github.com/tubearchivist/tubearchivist#installing-and-updating). If you see any issues here while using these instructions, please contribute.
|
These are beginner's guides/installation instructions for additional platforms generously provided by users of these platforms. When in doubt, verify the details with the [project README](https://github.com/tubearchivist/tubearchivist#installing). If you see any issues here while using these instructions, please contribute.
|
||||||
|
|
||||||
|
|
||||||
There are several different methods to install TubeArchivist on Synology platforms. This will focus on the available `docker` package implementation.<!-- and `docker-compose` implementations. -->
|
There are several different methods to install TubeArchivist on Synology platforms. This will focus on the available `docker` package implementation.<!-- and `docker-compose` implementations. -->
|
||||||
@ -166,7 +166,7 @@ Once all of the folders have been created, it should have a folder structure wit
|
|||||||
9. In the **Port Settings** tab, replace the "Auto" entry under **Local Port** with the port that will be used to connect to TubeArchivist (default is 8000).
|
9. In the **Port Settings** tab, replace the "Auto" entry under **Local Port** with the port that will be used to connect to TubeArchivist (default is 8000).
|
||||||
10. In the **Links** tab, select the "tubearchivist-es" container from the **Container Name** dropdown and provide it the same alias, "tubearchivist-es".
|
10. In the **Links** tab, select the "tubearchivist-es" container from the **Container Name** dropdown and provide it the same alias, "tubearchivist-es".
|
||||||
11. In the **Links** tab, select the "tubearchivist-redis" container from the **Container Name** dropdown and provide it the same alias, "tubearchivist-redis".
|
11. In the **Links** tab, select the "tubearchivist-redis" container from the **Container Name** dropdown and provide it the same alias, "tubearchivist-redis".
|
||||||
12. In the **Environment** tab, add in the following TubeArchivist specific environment variables that may apply. **Change the variables as is appropriate to your use case. Follow the [README section](https://github.com/tubearchivist/tubearchivist#tube-archivist) for details on what to set each variable.**
|
12. In the **Environment** tab, add in the following TubeArchivist specific environment variables that may apply. **Change the variables as is appropriate to your use case. Follow the [README section](https://github.com/tubearchivist/tubearchivist#installing) for details on what to set each variable.**
|
||||||
- `TA_HOST=synology.local`
|
- `TA_HOST=synology.local`
|
||||||
- `ES_URL=http://tubearchivist-es:9200`
|
- `ES_URL=http://tubearchivist-es:9200`
|
||||||
- `REDIS_HOST=tubearchivist-redis`
|
- `REDIS_HOST=tubearchivist-redis`
|
||||||
|
@ -1,10 +1,10 @@
|
|||||||
!!! note
|
!!! note
|
||||||
These are beginner's guides/installation instructions for additional platforms generously provided by users of these platforms. When in doubt, verify the details with the [project README](https://github.com/tubearchivist/tubearchivist#installing-and-updating). If you see any issues here while using these instructions, please contribute.
|
These are beginner's guides/installation instructions for additional platforms generously provided by users of these platforms. When in doubt, verify the details with the [project README](https://github.com/tubearchivist/tubearchivist#installing). If you see any issues here while using these instructions, please contribute.
|
||||||
|
|
||||||
Truenas Scale can be a bit confusing, with its k3s kubernetes implementation.
|
Truenas Scale can be a bit confusing, with its k3s kubernetes implementation.
|
||||||
|
|
||||||
However, there is a step by step guide available for it's users here:
|
However, there is a step by step guide available for it's users here:
|
||||||
|
|
||||||
https://heavysetup.info/applications/tube-archivist/dataset/
|
[heavysetup.info](https://heavysetup.info/applications/tube-archivist/dataset/)
|
||||||
|
|
||||||
- Ensure you are navigating the columns under `Tube Archivist` on the left hand side of the screen
|
- Ensure you are navigating the columns under `Tube Archivist` on the left hand side of the screen
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
!!! note
|
!!! note
|
||||||
These are beginner's guides/installation instructions for additional platforms generously provided by users of these platforms. When in doubt, verify the details with the [project README](https://github.com/tubearchivist/tubearchivist#installing-and-updating). If you see any issues here while using these instructions, please contribute.
|
These are beginner's guides/installation instructions for additional platforms generously provided by users of these platforms. When in doubt, verify the details with the [project README](https://github.com/tubearchivist/tubearchivist#installing). If you see any issues here while using these instructions, please contribute.
|
||||||
|
|
||||||
Tube Archivist, and all if it's dependencies are located in the [community applications](https://unraid.net/community/apps?q=tubearchivist) store. The three containers you will need are as follows:
|
Tube Archivist, and all if it's dependencies are located in the [community applications](https://unraid.net/community/apps?q=tubearchivist) store. The three containers you will need are as follows:
|
||||||
|
|
||||||
@ -12,7 +12,7 @@ Tube Archivist, and all if it's dependencies are located in the [community appli
|
|||||||
![TubeArchivist-RedisJSON](../assets/unraid_redis_install.png)
|
![TubeArchivist-RedisJSON](../assets/unraid_redis_install.png)
|
||||||
This is the easiest container to setup of the thee, just make sure that you do not have any port conflicts, and that your `/data` is mounted to the correct path. The other containers will map to the same root directory (/mnt/user/appdata/TubeArchivist).
|
This is the easiest container to setup of the thee, just make sure that you do not have any port conflicts, and that your `/data` is mounted to the correct path. The other containers will map to the same root directory (/mnt/user/appdata/TubeArchivist).
|
||||||
|
|
||||||
If you need to install `TubeArchivist-RedisJSON`on a different port, you'll have to follow [these steps](https://github.com/tubearchivist/tubearchivist#redis-on-a-custom-port) later on when installing the `TubeArchivist` container.
|
If you need to install `TubeArchivist-RedisJSON`on a different port, you'll have to follow [these steps](docker-compose.md#redis-on-a-custom-port) later on when installing the `TubeArchivist` container.
|
||||||
|
|
||||||
Make sure and start Redis and the ElasticSearch containers approximately one minute before starting `TubeArchivist`
|
Make sure and start Redis and the ElasticSearch containers approximately one minute before starting `TubeArchivist`
|
||||||
|
|
||||||
|
@ -7,6 +7,7 @@ The playlists are organized in two different levels, similar as the [channels](c
|
|||||||
|
|
||||||
## Playlist Overview
|
## Playlist Overview
|
||||||
Accessible at `/playlist/` of your Tube Archivist, this **Overview Page** shows a list of all playlists you have indexed over all your channels.
|
Accessible at `/playlist/` of your Tube Archivist, this **Overview Page** shows a list of all playlists you have indexed over all your channels.
|
||||||
|
|
||||||
- You can filter that list to show only subscribed to playlists with the toggle.
|
- You can filter that list to show only subscribed to playlists with the toggle.
|
||||||
|
|
||||||
You can index playlists of a channel from the channel detail page as described [here](channels.md#channel-detail).
|
You can index playlists of a channel from the channel detail page as described [here](channels.md#channel-detail).
|
||||||
|
@ -80,7 +80,7 @@ All third party integrations of TubeArchivist will **always** be *opt in*.
|
|||||||
|
|
||||||
- **API**: Your access token for the Tube Archivist API.
|
- **API**: Your access token for the Tube Archivist API.
|
||||||
- **returnyoutubedislike.com**: This will get return dislikes and average ratings for each video by integrating with the API from [returnyoutubedislike.com](https://www.returnyoutubedislike.com/).
|
- **returnyoutubedislike.com**: This will get return dislikes and average ratings for each video by integrating with the API from [returnyoutubedislike.com](https://www.returnyoutubedislike.com/).
|
||||||
- **SponsorBlock**: Using [SponsorBlock](https://sponsor.ajay.app/) to get and skip sponsored content. If a video doesn't have timestamps, or has unlocked timestamps, use the browser addon to contribute to this excellent project. Can also be activated and deactivated as a per [channel overwrite](settings.md#channel-customize).
|
- **SponsorBlock**: Using [SponsorBlock](https://sponsor.ajay.app/) to get and skip sponsored content. If a video doesn't have timestamps, or has unlocked timestamps, use the browser addon to contribute to this excellent project. Can also be activated and deactivated as a per [channel overwrite](channels.md#about).
|
||||||
|
|
||||||
## Snapshots
|
## Snapshots
|
||||||
!!! note
|
!!! note
|
||||||
|
Loading…
Reference in New Issue
Block a user