From 2cec0a674d37d08aba1773f09450d68bd84faffb Mon Sep 17 00:00:00 2001 From: Diptesh Choudhuri Date: Fri, 21 Jun 2024 13:09:46 +0530 Subject: [PATCH] docs: better info about upgrading --- docs/content/index.md | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/docs/content/index.md b/docs/content/index.md index 6f93db0ad3..3393a25ac0 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -1,9 +1,8 @@ # Installation -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 [features -page]({{extra.main_website_url }}/features). +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 +}}/features). ```yaml services: @@ -19,10 +18,9 @@ services: container_name: ryot-db ryot: - image: ignisda/ryot-pro:latest # or ignisda/ryot:latest for the community version + image: ignisda/ryot:latest # or ghcr.io/ignisda/ryot:latest environment: - DATABASE_URL=postgres://postgres:postgres@ryot-db:5432/postgres - - SERVER_PRO_KEY= # if using the pro version # - FRONTEND_INSECURE_COOKIES=true # if running on HTTP ports: - "8000:8000" @@ -33,15 +31,22 @@ volumes: postgres_storage: ``` -!!! info +## Upgrading to Pro - The first user you register is automatically set as admin of the instance. +!!! info -## Upgrading to Pro + The pro version is not backwards compatible with the community version, so be sure to + backup 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 [main website]({{ extra.main_website_url }}). +You can get a key by contacting us via the [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. +Once you have the key, you can set it in the `docker-compose.yml` file: + +```diff + ryot: +- image: ignisda/ryot:latest # or ghcr.io/ignisda/ryot:latest ++ image: ignisda/ryot-pro:latest # or ghcr.io/ignisda/ryot-pro:latest + environment: ++ - SERVER_PRO_KEY= +```