Skip to content

Commit

Permalink
docs: better info about upgrading
Browse files Browse the repository at this point in the history
  • Loading branch information
IgnisDa committed Jun 21, 2024
1 parent 4f64aa4 commit 2cec0a6
Showing 1 changed file with 18 additions and 13 deletions.
31 changes: 18 additions & 13 deletions docs/content/index.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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=<pro_key_issued_to_you> # if using the pro version
# - FRONTEND_INSECURE_COOKIES=true # if running on HTTP
ports:
- "8000:8000"
Expand All @@ -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=<pro_key_issued_to_you>
```

0 comments on commit 2cec0a6

Please sign in to comment.