Skip to content

Commit 7054c51

Browse files
committed
Started documenting the upgrade process
1 parent 808af0d commit 7054c51

File tree

3 files changed

+37
-0
lines changed

3 files changed

+37
-0
lines changed

docs/upgrade/1_to_2.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
layout: default
3+
title: Upgrade from Part-DB 1.x to 2.x
4+
nav_order: 1
5+
has_children: false
6+
---
7+
8+
# Upgrade from Part-DB 1.x to 2.x
9+
10+
Part-DB 2.0 is a major release that changes a lot of things internally, but it is still compatible with Part-DB 1.x.
11+
Depending on your preferences, you will have to do some changes to your Part-DB installation, this document will guide
12+
you through the upgrade process.
13+
14+
## New requirements
15+
*If you are running Part-DB inside a docker container, you can skip this section, as the new requirements are already
16+
fulfilled by the official Part-DB docker image.*
17+
18+
Part-DB 2.0 requires at least PHP 8.2 (newer versions are recommended). So if your existing Part-DB installation is still
19+
running PHP 8.1, you will have to upgrade your PHP version first.
20+
The minimum required version of node.js is now 20.0 or newer, so if you are using 18.0, you will have to upgrade it too.
21+
22+
Most distributions should have the possibility to get backports for PHP 8.4 and modern nodejs, so you should be able to
23+
easily upgrade your system to the new requirements. Otherwise, you can use the official Part-DB docker image, which
24+
ships all required dependencies and is always up to date with the latest requirements, so that you do not have to worry
25+
about the requirements at all.
26+
27+

docs/upgrade/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
layout: default
3+
title: Upgrade
4+
nav_order: 7
5+
has_children: true
6+
---
7+
8+
This section provides information on how to upgrade Part-DB to the latest version.
9+
This is intended for major release upgrades, where requirements or things changes significantly.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: default
33
title: Upgrade from legacy Part-DB version (<1.0)
44
nav_order: 100
5+
redirect_from: /upgrade_legacy
56
---
67

78
# Upgrade from legacy Part-DB version

0 commit comments

Comments
 (0)