testing.md 3.29 KB
Newer Older
Karel Koci's avatar
Karel Koci committed
1
2
3
4
---
board: mox, omnia, 1.x
competency: advanced
---
5
# How to try future releases of Turris OS?
6

7
8
9
Do you want to contribute to better stability of Turris OS? Or would you just
like to try the latest and greatest that is not yet released? Do you want to
try even unstable features that developers are still working on? You can do all
10
of that! This manual will tell you how.
11
12

Turris OS is currently released in various branches, which have different
13
functions and varying stability – you can pick, which branch you want to test.
14
15
16
17
18
19

## Branches available

Following list describes various branches you might want to try and their main
functions. They are ordered from the most stable to the most experimental.

20
### HBS – _Here Be Snails (Stable)_
21
22
23
24

Default and most stable branch. Suggested for all users. This contains
official releases and is what everybody is running by default.

25
### HBT – _Here Be Turtles (Testing)_
26
27
28
29
30
31
32
33
34

Release candidate. This branch contains next Turris OS release just before the
official release. Please join this branch to help us test the next release.
It's mostly considered stable but can contain minor bugs that escaped the
testing.

Suitable to help test the releases, might require some manual intervention from
time to time, but not too often.

35
### HBK – _Here Be Kittens_
36

37
Automatic builds the next fixup (e.g. 5.1.8) release will be based on. Combines the
38
latest stable OpenWrt and stable Turris features.
39
40
41
42
43

Suitable for people interested in testing future fixes and not minding occasional
bugs. As this is an integration branch, it breaks from time to time. But nothing
that experienced user can't recover from.

44
### HBL – _Here Be Lions_
45

46
Automatic builds the next minor (e.g. 5.2.0) release will be based on. Combines the
47
latest stable OpenWrt and the latest of our features.
48
49
50
51
52

Suitable for people interested in testing latest features and not minding
occasional bugs. As this is an integration branch, it breaks from time to time.
But nothing that experienced user can't recover from.

53
### HBD – _Here Be Dragons_
54

55
Automatic builds of next major (e.g. 6.0.0) release based on next OpenWrt release.
56
Mainly considered as a preview to test for integration problems.
57
58

Suitable for distribution developers or people in desperate need of new
59
OpenWrt. Generallly considered dangerous and can seriously break or stop being
60
61
62
built for some time without any warning.

More information about development workflow can be found in the
63
[turris-build repository](https://gitlab.nic.cz/turris/os/build/blob/hbk/WORKFLOW.adoc).
64
65
66
67
68
69
70
71
72
73
74
75
76

## How to switch to various branches

Connect to your router as root through `ssh` and enter the following command:

```
switch-branch hbt
```

After having entered this command, you have switched permanently to the
_"turtles"_ branch and an automatic update will start and let you test the next
release before it is actually released publicly. If you want to switch to a
different branch, just replace the `hbt` argument with the name of the branch
77
of your choice.
78
79

### Switching back
80

81

82
83
84
85
86
87
88
Switching from less stable branches to more stable branches (from HBD to HBL, HBL to HBK, etc.)
is possible but it is not a supported scenario. Because of that, we don't recommend it.
You can brick your router.

It is recommended to use a snapshot and rollback to the last stable version.
(see [schnapps](./schnapps/schnapps.md))

89