Skip to content

Commit 4f64aa4

Browse files
committed
docs: information about pro version
1 parent 3767209 commit 4f64aa4

File tree

4 files changed

+21
-6
lines changed

4 files changed

+21
-6
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
</div>
2222

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

40+
## Pro version
41+
42+
Ryot is available in two versions - community and pro. The pro version has additional
43+
features like recommendations, supercharged collections etc. Learn more about the pro
44+
version [here](https://ryot.io/features).
45+
3946
## 💻 Demo
4047

4148
You can use the demo account on the Ryot website. Login with the username `demo` and

apps/landing/src/data/landing.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@
2929
{ "label": "Prices", "href": "/#pricing-section" },
3030
{ "label": "Features", "href": "/features" },
3131
{ "label": "Contact", "href": "/#contact-section" },
32-
{ "label": "Documentation", "href": "https://docs.ryot.io" },
33-
{ "label": "Terms of Service", "href": "/terms" }
32+
{ "label": "Documentation", "href": "https://docs.ryot.io" }
3433
]
3534
},
3635
"heroData": {

apps/landing/src/pages/features.astro

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ const data = await getLandingData();
3030
media consumption. They are refreshed every hour.
3131
</p>
3232
<img
33-
src="images/features/recommendations.png"
33+
src="/images/features/recommendations.png"
3434
class="lg:w-[600px] border rounded-lg shadow-lg"
3535
/>
3636
</div>
@@ -43,7 +43,7 @@ const data = await getLandingData();
4343
class="gap-y-5 flex flex-col items-center justify-between md:gap-x-10 md:flex-row"
4444
>
4545
<img
46-
src="images/features/add-to-others-collection.png"
46+
src="/images/features/add-to-others-collection.png"
4747
class="lg:w-[600px] border rounded-lg shadow-lg"
4848
/>
4949
<ul class="list-disc list-inside">

docs/content/index.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

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

88
```yaml
99
services:
@@ -36,3 +36,12 @@ volumes:
3636
!!! info
3737
3838
The first user you register is automatically set as admin of the instance.
39+
40+
## Upgrading to Pro
41+
42+
To upgrade to the pro version, you need to provide a `SERVER_PRO_KEY` environment variable.
43+
You can get a key by contacting us via the [main website]({{ extra.main_website_url }}).
44+
45+
Once you have the key, you can set it in the `docker-compose.yml` file as shown above.
46+
Please note that the pro version is not backwards compatible with the community version, so
47+
sure to backup your data before upgrading.

0 commit comments

Comments
 (0)