Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.

Commit 13e0116

Browse files
ctalledorodnymolina
authored andcommitted
Added small section on shiftfs to distro-compat doc.
1 parent c357144 commit 13e0116

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

docs/distro-compat.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,14 @@ package to do the upgrade as follows:
2929
```console
3030
$ sudo apt-get update && sudo apt install --install-recommends linux-generic-hwe-18.04 -y
3131
```
32+
33+
### Using Sysbox On Kernels Without the Shiftfs Module
34+
35+
Recent Ubuntu kernels carry a module called `shiftfs` that Sysbox uses as part
36+
of its container isolation strategy.
37+
38+
However, some Ubuntu cloud images do not carry the module. In this case, Sysbox
39+
requires that Docker be configured in [userns-remap mode](https://docs.docker.com/engine/security/userns-remap/).
40+
41+
The Sysbox installer will detect this condition and can automatically put
42+
Docker in userns-remap mode if desired. See [here](user-guide/install.md#docker-userns-remap) for details.

docs/user-guide/install.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ The Linux host on which Sysbox runs must meet the following requirements:
2222

2323
## Installing Sysbox
2424

25+
**NOTE**: if you have a prior version of Sysbox already installed, please [uninstall it](#uninstalling-sysbox) first and then follow the installation instructions below.
26+
2527
1) Download the latest Sysbox package from the [release](https://github.com/nestybox/sysbox-external/releases) page.
2628

2729
2) Verify that the checksum of the downloaded file fully matches the expected/published one.
@@ -102,7 +104,7 @@ WARNING: No swap limit support
102104

103105
### Docker Userns-Remap
104106

105-
In addition, the Sysbox installer will detect if Docker needs to be placed
107+
During installation, the Sysbox installer will also check if Docker needs to be placed
106108
in [userns-remap mode](https://docs.docker.com/engine/security/userns-remap/) or not.
107109

108110
The installer uses the following logic:

0 commit comments

Comments
 (0)