Skip to content

Commit 0946960

Browse files
committed
Add upgrade steps
1 parent 80c5e86 commit 0946960

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

docs/_faq/upgrading.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: How to upgrade TerrariumPI
3+
categories: [Website, FAQ]
4+
tags: [upgrade]
5+
---
6+
7+
Depending on your setup, follow the docker or manual [upgrade steps]({% link _tabs/install.md %}#upgrading) at the installation page.

docs/_tabs/install.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,31 @@ sudo ./install.sh
128128

129129
After the installation is done, reboot once and you should be able to access TerrariumPI on the url `http://[raspberrypi]:8090`. [Continue with the setup]({% link _tabs/setup.md %})
130130

131+
## Upgrading
132+
133+
Upgrading between minor versions is mostly running a few commands. Depending on a docker or manual installation, follow the steps below. After the upgrade is done, make sure you clear your browser cache. Else you can get the old interface or a broken interface.
134+
135+
### Docker
136+
137+
We assume you are use docker compose and at the folder where the `docker-compose.yaml` file is.
138+
139+
1. Stop the docker container: `docker compose stop`
140+
2. Change the version number in `docker-compose.yaml` and run `docker compose pull`
141+
3. Start the docker container: `docker compose up -d`
142+
143+
And a new version should be running. A reboot is not needed.
144+
145+
### Manual
146+
147+
We assume you are at the folder where TerrariumPI is installed with git.
148+
149+
1. Stop TerrariumPI: `sudo service terrariumpi stop`
150+
2. Update the code: `git pull`
151+
3. Rerun the installer: `sudo ./install`
152+
4. Start TerrariumPI: `sudo service terrariumpi start`
153+
154+
And a new version should be running. A reboot is not needed.
155+
131156
## Migration from V3 to V4
132157

133158
There is **no real migration** from version 3 to version 4. The changes are to big. So that means you have to install TerrariumPI v4 as it was a new PI. These migrations steps will only copy the *existing relay history data* from V3 to V4 so that the total power and water usages is still there. And the total costs are still correct. This is all what will be migrated.

0 commit comments

Comments
 (0)