Skip to content

Commit

Permalink
docs: information about pro version
Browse files Browse the repository at this point in the history
  • Loading branch information
IgnisDa committed Jun 21, 2024
1 parent 3767209 commit 4f64aa4
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 6 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
</div>

<p align="center">
<a href="https://ryot.io/features" target="_blank">Pro features</a> •
<a href="https://docs.ryot.io" target="_blank">Installation</a> •
<a href="https://docs.ryot.io/configuration" target="_blank">Configuration</a> •
<a href="https://app.ryot.io" target="_blank">Hosted version</a>
Expand All @@ -36,6 +37,12 @@ hosted tracker you will ever need!
If you were using `v5.*` of Ryot, please read the
[migration guide](https://docs.ryot.io/migration#from-v5-to-v6) for instructions.

## Pro version

Ryot is available in two versions - community and pro. The pro version has additional
features like recommendations, supercharged collections etc. Learn more about the pro
version [here](https://ryot.io/features).

## 💻 Demo

You can use the demo account on the Ryot website. Login with the username `demo` and
Expand Down
3 changes: 1 addition & 2 deletions apps/landing/src/data/landing.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@
{ "label": "Prices", "href": "/#pricing-section" },
{ "label": "Features", "href": "/features" },
{ "label": "Contact", "href": "/#contact-section" },
{ "label": "Documentation", "href": "https://docs.ryot.io" },
{ "label": "Terms of Service", "href": "/terms" }
{ "label": "Documentation", "href": "https://docs.ryot.io" }
]
},
"heroData": {
Expand Down
4 changes: 2 additions & 2 deletions apps/landing/src/pages/features.astro
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const data = await getLandingData();
media consumption. They are refreshed every hour.
</p>
<img
src="images/features/recommendations.png"
src="/images/features/recommendations.png"
class="lg:w-[600px] border rounded-lg shadow-lg"
/>
</div>
Expand All @@ -43,7 +43,7 @@ const data = await getLandingData();
class="gap-y-5 flex flex-col items-center justify-between md:gap-x-10 md:flex-row"
>
<img
src="images/features/add-to-others-collection.png"
src="/images/features/add-to-others-collection.png"
class="lg:w-[600px] border rounded-lg shadow-lg"
/>
<ul class="list-disc list-inside">
Expand Down
13 changes: 11 additions & 2 deletions docs/content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

Images are also available on the Github Container Registry as `ghcr.io/ignisda/ryot-pro`.
If you would like to run the pro version, you need to provide a `SERVER_PRO_KEY`
environment variable. To see the features of the pro version, check the [main website]({{
extra.main_website_url }}/features).
environment variable. To see the features of the pro version, check the [features
page]({{extra.main_website_url }}/features).

```yaml
services:
Expand Down Expand Up @@ -36,3 +36,12 @@ volumes:
!!! info
The first user you register is automatically set as admin of the instance.
## Upgrading to Pro
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 [main website]({{ extra.main_website_url }}).

Once you have the key, you can set it in the `docker-compose.yml` file as shown above.
Please note that the pro version is not backwards compatible with the community version, so
sure to backup your data before upgrading.

0 comments on commit 4f64aa4

Please sign in to comment.