Skip to content

Commit

Permalink
docs: update outdated information
Browse files Browse the repository at this point in the history
  • Loading branch information
IgnisDa committed Aug 1, 2024
1 parent e147a56 commit 2b40a68
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 29 deletions.
2 changes: 1 addition & 1 deletion docs/content/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ reverse proxy and are managed by `concurrently`.
Each version of Ryot is released as a docker image. Then it is associated with the latest
Github release of the major version. For example, if the latest tag is `v5.2.1`, then
the Github release will be called `Version 5` and the docker image will be tagged as
`:v5.2.1` and `:latest`.
`:v5.2.1`, `v5.2`, `v5` and `:latest`.

## Development

Expand Down
2 changes: 1 addition & 1 deletion docs/content/guides/video-games.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A guide about video games integration for Ryot.

Ryot supports tracking video games via [IGDB](https://www.igdb.com/). However, the API is
heavily rate limited, so it is not possible to hardcode the API keys in the application
(unlike the other keys).
(unlike the others).

You can follow the below steps to obtain your own API keys and enable video game tracking.

Expand Down
10 changes: 5 additions & 5 deletions docs/content/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# Installation

If you would like to run the pro version, please check [below](#upgrading-to-pro). To see
the features of the pro version, check the [features page]({{extra.main_website_url
}}).

```yaml
services:
ryot-db:
Expand Down Expand Up @@ -32,6 +28,10 @@ volumes:
postgres_storage:
```
If you would like to run the pro version, please check [below](#upgrading-to-pro). To see
the features of the pro version, check the [features page]({{extra.main_website_url
}}).
## Upgrading to Pro
!!! info
Expand All @@ -40,7 +40,7 @@ volumes:
[backup](./guides/exporting.md#exporting-the-entire-database) your data before upgrading.
To upgrade to the pro version, you need to provide a `SERVER_PRO_KEY` environment variable.
You can get a key by contacting us via the [website]({{ extra.main_website_url }}).
You can get a key by purchasing it from the [website]({{ extra.main_website_url }}).

Once you have the key, you can set it in the `docker-compose.yml` file:

Expand Down
29 changes: 7 additions & 22 deletions docs/content/integrations.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Integrations

Integrations can be used to continuously update your media progress. They can be of two
types:
Integrations can be used to continuously update your media progress or inform external
services about changes. They can be of following types:

- _Yank_: Progress data is downloaded from an externally running server at a periodic
interval.
- _Push_: Ryot sends data to an external service.
- _Push_: Ryot sends data to an external service at a periodic interval.
- _Sink_: An external client publishes progress updates to the Ryot server.

## Yank integrations
Expand All @@ -25,7 +25,7 @@ You can configure the interval at which the data is fetched from the external us
[import](./importing.md#audiobookshelf) if you want to import media that are finished.

The [Audiobookshelf](https://www.audiobookshelf.org) integration can sync all media if they
have an Audible ID or ITunes ID or ISBN.
have a valid provider ID (Audible, ITunes or ISBN).

1. Obtain an API token as described in the Audiobookshelf
[authentication](https://api.audiobookshelf.org/#authentication) docs.
Expand All @@ -34,7 +34,7 @@ have an Audible ID or ITunes ID or ISBN.

## Push integrations

Follow the same instructions as the [yank](#yank-integrations) integrations to add.
Follow the same instructions as the [yank](#yank-integrations) integrations to add one.

### Radarr

Expand All @@ -52,7 +52,8 @@ Automatically add shows in the selected collections to Sonarr.

## Sink integrations

All webhook URLs follow this format:
These work via webhooks wherein an external service can inform Ryot about a change. All
webhook URLs follow this format:

```txt
https://<instance_url>/backend/_i/<slug>
Expand Down Expand Up @@ -136,19 +137,3 @@ TMDb ID attached to their metadata.
the zipped addon to your Kodi instance. Once installed, it will be visible under
the "Services" sub category named "Ryot".
4. Click on "Configure" to fill in the correct details.

### Flow Launcher

!!! warning

This is a community maintained integration.

The plugin for [Flow Launcher](https://www.flowlauncher.com/) allows you to quickly
search your Ryot tracker by media category:

![image](https://imgur.com/gVt9VBd.gif)

To install, search for "Ryot" in the Flow Launcher plugin store. Or use `pm install ryot`.

Refer to the [documentation](https://github.com/bretthysuik/Flow.Launcher.Plugin.Ryot#configuration)
for post-install configuration.

0 comments on commit 2b40a68

Please sign in to comment.