Skip to content
Open
Changes from all commits
Commits
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
46 changes: 46 additions & 0 deletions docs/NODE_UPGRADE_NOTES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Node Upgrade Notes

This document summarizes a few best practices when upgrading a Base node.

## 1. Back up data

Before upgrading, back up:

- the data directory (for example `geth-data`),
- any local configuration files (`.env`, `config/*.env`),
- Docker compose files if you have customized them.

## 2. Check release notes

Always check the release notes of the new version for:

- breaking changes,
- required flags or configuration changes,
- migration steps.

## 3. Rolling upgrade (Docker)

For Docker-based setups:

1. Stop the existing containers:

docker compose down

2. Pull the new images:

docker pull <new-image-tags>

3. Start the node again:

docker compose up -d

4. Monitor logs for a few minutes to ensure the node syncs correctly.

## 4. Rollback plan

Keep a short rollback plan:

- how to restore the previous image tag,
- how to restore the backed up data directory.

Having this written down reduces downtime if something goes wrong.