Skip to content

docs: Add general upgrade procedure for validators in upgrade.mdx #323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AgustinRamiroDiaz merged 3 commits into from
Dec 29, 2025
Merged

docs: Add general upgrade procedure for validators in upgrade.mdx #323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b89f2f8
docs: Add general upgrade procedure for validators in upgrade.mdx
AgustinRamiroDiaz Dec 26, 2025
68010da
improve upgrade guide
AgustinRamiroDiaz Dec 26, 2025
a55e847
fix llm comments on setup guide
AgustinRamiroDiaz Dec 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions pages/validators/setup-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,9 +408,10 @@ The GenVM configuration files are located at `third_party/genvm/config/`

This is the configuration file of the LLM module. In this file you can set up and configure various LLM providers, as well as the system prompts of your validator.

You can turn on and off various LLMs by setting the `enabled` field to `false`.
You should not need to modify this in general.

At this stage, select one LLM and set all other to disabled.
However, from here you can:
- turn on and off various LLMs by setting the `enabled` field to `false`: By default they all come enabled for you to use. You will get warnings in the logs for each one that's enabled and not configured. Disabling non used LLM providers will hide those warnings

Note environment variable names for LLM API keys (e.g., `HEURISTKEY`, `COMPUT3KEY`, `IOINTELLIGENCE_API_KEY`). You will need to ensure the appropriate key is correctly set before [running the node](#running-the-node).

Expand Down
6 changes: 6 additions & 0 deletions pages/validators/upgrade.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ import { Callout } from "nextra-theme-docs";
A fully Zero-downtime upgrade procedure is coming in a future update.
</Callout>

## General Procedure

1. **Download the new package and extract into a fresh folder** - Always use a clean directory for the new version.
2. **Override with your custom config** - Configure the files in the new installation as you did when [setting up your node](/validators/setup-guide). Example: `.env` and `config.yaml`. You can refer to your previous settings. Avoid directly copying these files, as new versions may include updated default configurations.
3. **Copy the contents of your old data folder** - The `data/` folder is the stateful directory used by the node, containing the database and keystore. This step is not needed if your data folder is located outside of the project directory.

## v0.3.x → v0.4 (Breaking Change)

`v0.4` switches to a new consensus deployment with staking. For this reason, the validator must be set up from scratch without reusing the old database stored at `data/node/genlayer.db`.
Expand Down