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

Commit 6f95803

Browse files
ctalledorodnymolina
authored andcommitted
Rebranded sysboxd -> sysbox.
1 parent 12ef891 commit 6f95803

File tree

6 files changed

+155
-153
lines changed

6 files changed

+155
-153
lines changed

README.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Nestybox Sysboxd
2-
================
1+
Sysbox: System Container Runtime
2+
================================
33

44
## About Nestybox
55

@@ -18,20 +18,20 @@ efficient, and easy-to-use alternative to virtual machines for
1818
deploying virtual hosts on Linux. And for this work out-of-the-box and
1919
securely, without complex configurations or hacks.
2020

21-
## About Sysboxd
21+
## About Sysbox
2222

23-
Sysboxd is software that installs on a Linux host and integrates with Docker,
23+
Sysbox is software that installs on a Linux host and integrates with Docker,
2424
enabling Docker to create [system containers](docs/system-containers.md).
2525

26-
Users do not normally interact with Sysboxd directly. Instead, users
26+
Users do not normally interact with Sysbox directly. Instead, users
2727
create system containers with Docker. See [Usage](#usage) below for more info.
2828

2929
## Features
3030

3131
**NOTE**: It's early days for Nestybox, so our system containers
3232
support a reduced set of features and use-cases at this time.
3333

34-
Below is a list of features currently supported by Sysboxd. Please
34+
Below is a list of features currently supported by Sysbox. Please
3535
see our [Roadmap](#roadmap) for a list of features we are working on.
3636

3737
### Deployment
@@ -93,7 +93,7 @@ We plan to add support for more distros in the future.
9393

9494
## Host Requirements
9595

96-
The Linux host on which Sysboxd runs must meet the following requirements:
96+
The Linux host on which Sysbox runs must meet the following requirements:
9797

9898
1) Systemd must be running as the system's process-manager.
9999

@@ -113,20 +113,20 @@ The Linux host on which Sysboxd runs must meet the following requirements:
113113

114114
## Installation
115115

116-
1) Download the latest package from the [release](https://github.com/nestybox/sysboxd-external/releases) page.
116+
1) Download the latest package from the [release](https://github.com/nestybox/sysbox-external/releases) page.
117117

118118
2) Verify that the checksum of the downloaded file fully matches the expected/published one.
119119
For example:
120120

121121
```bash
122-
$ sha256sum ~/sysboxd_0.0.1-0~ubuntu-bionic_amd64.deb
123-
2a02898dc53b4751cf413464b977f5b296d9aac3c5b477e05272bfa881d69cfc /home/user/sysboxd_0.0.1-0~ubuntu-bionic_amd64.deb
122+
$ sha256sum ~/sysbox_0.0.1-0~ubuntu-bionic_amd64.deb
123+
2a02898dc53b4751cf413464b977f5b296d9aac3c5b477e05272bfa881d69cfc /home/user/sysbox_0.0.1-0~ubuntu-bionic_amd64.deb
124124
```
125125

126-
3) Install the Sysboxd package:
126+
3) Install the Sysbox package:
127127

128128
```bash
129-
$ sudo dpkg -i sysboxd_0.0.1-0~ubuntu-bionic_amd64.deb
129+
$ sudo dpkg -i sysbox_0.0.1-0~ubuntu-bionic_amd64.deb
130130
```
131131

132132
In case you hit an error with missing dependencies, fix this with:
@@ -136,28 +136,28 @@ $ sudo apt-get install -f -y
136136
```
137137

138138
This will install the missing dependencies and automatically re-launch
139-
the Sysboxd installation process.
139+
the Sysbox installation process.
140140

141141

142-
4) Verify that Sysboxd's systemd units have been properly installed, and
142+
4) Verify that Sysbox's systemd units have been properly installed, and
143143
associated daemons are properly running:
144144

145145
```
146146
$ systemctl list-units -t service --all | grep sysbox
147147
sysbox-fs.service loaded active running sysbox-fs component
148148
sysbox-mgr.service loaded active running sysbox-mgr component
149-
sysboxd.service loaded active exited Sysboxd General Service
149+
sysbox.service loaded active exited Sysbox General Service
150150
```
151151

152-
Note: the sysboxd.service is ephemeral (it exits once it launches the other sysboxd services).
152+
Note: the sysbox.service is ephemeral (it exits once it launches the other sysbox services).
153153

154-
If you are curious on what the other Sysboxd services are, refer to the [Sysboxd design document](docs/design.md).
154+
If you are curious on what the other Sysbox services are, refer to the [Sysbox design document](docs/design.md).
155155

156156
If you hit problems during installation, see the [Troubleshooting document](docs/troubleshoot.md).
157157

158158
## Usage
159159

160-
To launch a system container with Docker, point Docker to the Sysboxd container
160+
To launch a system container with Docker, point Docker to the Sysbox container
161161
runtime, using the `--runtime=sysbox-runc` option:
162162

163163
```bash
@@ -173,8 +173,8 @@ It's perfectly fine to run system containers along side with regular
173173
Docker application containers on the host at the same time; they won't
174174
conflict.
175175

176-
Refer to the [Sysboxd User's Guide](docs/usage.md) for other ways to
177-
run system containers with Sysboxd.
176+
Refer to the [Sysbox User's Guide](docs/usage.md) for other ways to
177+
run system containers with Sysbox.
178178

179179
If you hit problems with the instructions above, see the
180180
[Troubleshooting document](docs/troubleshoot.md).
@@ -196,27 +196,27 @@ See [here](docs/usage.md#running-software-inside-the-system-container) for more
196196

197197
## Integration with Container Managers
198198

199-
Sysboxd is designed to work with Docker / containerd.
199+
Sysbox is designed to work with Docker / containerd.
200200

201201
We don't yet support other container managers (e.g., cri-o).
202202

203203
## Design
204204

205-
For more detailed info about Sysboxd's design, refer to the
206-
[Sysboxd design document](docs/design.md).
205+
For more detailed info about Sysbox's design, refer to the
206+
[Sysbox design document](docs/design.md).
207207

208208
## OCI Compatibility
209209

210-
Sysboxd is a fork of the [OCI runc](https://github.com/opencontainers/runc). It is mostly
210+
Sysbox is a fork of the [OCI runc](https://github.com/opencontainers/runc). It is mostly
211211
(but not 100%) compatible with the OCI runtime specification. See [here](docs/design.md#oci-compatibility)
212212
for a list of incompatibilities.
213213

214214
We believe these incompatibilities won't negatively affect users of
215-
Sysboxd and should mostly be transparent to them.
215+
Sysbox and should mostly be transparent to them.
216216

217217
## Production Readiness
218218

219-
Sysboxd is still in Beta. It's stable, but not production ready yet.
219+
Sysbox is still in Beta. It's stable, but not production ready yet.
220220

221221
## Troubleshooting
222222

@@ -227,12 +227,12 @@ Refer to the [Troubleshooting document](docs/troubleshoot.md).
227227
We apologize for any problems in the product or documentation, and we appreciate
228228
customers filing issues that help us improve them.
229229

230-
To file issues with Sysboxd (e.g., bugs, feature requests, documentation changes, etc.),
230+
To file issues with Sysbox (e.g., bugs, feature requests, documentation changes, etc.),
231231
please refer to the [issue guidelines](docs/issue-guidelines.md) document.
232232

233233
## Roadmap
234234

235-
The following is a list of features in the Sysboxd roadmap.
235+
The following is a list of features in the Sysbox roadmap.
236236

237237
We list these here so that our users can get a better idea of where we
238238
are going and can give us feedback on which of these they like best
@@ -259,7 +259,7 @@ Here is the list:
259259

260260
## Feedback
261261

262-
We love feedback, as it helps us improve Sysboxd and set its future
262+
We love feedback, as it helps us improve Sysbox and set its future
263263
direction.
264264

265265
We would much appreciate if you would take a couple of minutes to
@@ -269,20 +269,20 @@ https://www.surveymonkey.com/r/SH8HMGY
269269

270270
## Uninstallation
271271

272-
Prior to uninstalling Sysboxd, make sure all system containers are removed.
272+
Prior to uninstalling Sysbox, make sure all system containers are removed.
273273
There is a simple shell script to do this [here](scr/rm_all_syscont).
274274

275-
1) Uninstall Sysboxd binaries:
275+
1) Uninstall Sysbox binaries:
276276

277277
```bash
278-
$ sudo dpkg --remove sysboxd
278+
$ sudo dpkg --remove sysbox
279279
```
280280

281281
Alternatively, remove the above items plus all the associated
282282
configuration and systemd files (recommended):
283283

284284
```bash
285-
$ sudo dpkg --purge sysboxd
285+
$ sudo dpkg --purge sysbox
286286
```
287287

288288
2) Unload the `nbox_shiftfs` module:
@@ -291,10 +291,10 @@ $ sudo dpkg --purge sysboxd
291291
$ sudo rmmod nbox_shiftfs
292292
```
293293

294-
3) Finally remove the `sysboxd` user from the system:
294+
3) Finally remove the `sysbox` user from the system:
295295

296296
```bash
297-
$ sudo userdel sysboxd
297+
$ sudo userdel sysbox
298298
```
299299

300300
## Contact
@@ -304,7 +304,7 @@ be happy to help.
304304

305305
## Thank You!
306306

307-
We thank you **very much** for using Sysboxd. We hope you find it useful.
307+
We thank you **very much** for using Sysbox. We hope you find it useful.
308308

309309
Your trust in us is very much appreciated.
310310

dockerfiles/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Nestybox System Container Dockerfiles
44
This directory contains the Dockerfiles for system container images
55
uploaded to the Nestybox public repos on DockerHub.
66

7+
The Dockerfiles and associated images are meant to be used as examples.
8+
79
Feel free to copy them and modify them to your needs, or source them
810
from within your Dockerfiles.
911

0 commit comments

Comments
 (0)