Skip to content

Commit 4fbc63b

Browse files
committed
Update readme
1 parent fe2f3ee commit 4fbc63b

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Sysbox Installer for dstack
22

3-
A complete Docker-based installer for [Sysbox](https://github.com/nestybox/sysbox) on read-only dstack systems.
3+
A Docker-based installer for [Sysbox](https://github.com/nestybox/sysbox) on read-only dstack systems.
44

55
## Features
66

77
- 🚀 **Single-command installation** - One Docker run command installs everything
88
- 🔒 **Source-built** - Builds Sysbox from verified Git source (v0.6.7)
9-
-**SHA256 verified** - All downloads verified with checksums
9+
-**SHA256 verified** - All downloads verified with checksums
1010
- 🔄 **Smart overlay handling** - Preserves existing /etc configurations
1111
- 📋 **Systemd integration** - Installs proper systemd services for Sysbox daemons
1212
- 🔍 **Installation detection** - Checks for existing installations
@@ -32,12 +32,10 @@ docker run --rm --privileged --pid=host --net=host -v /:/host \
3232

3333
That's it! The installer will:
3434
- Check for existing installations
35-
- Build and install Sysbox from source
35+
- Build and install Sysbox from source
3636
- Handle /etc overlay mount complexities
3737
- Configure Docker runtime
3838
- Create and start systemd services
39-
- Test the installation
40-
- Show final status
4139

4240
## Manual Steps (if needed)
4341

@@ -67,7 +65,7 @@ docker run --runtime=sysbox-runc -it ubuntu bash
6765
# Docker-in-Docker
6866
docker run --runtime=sysbox-runc -d --name docker-container docker:dind
6967

70-
# Kubernetes-in-Docker
68+
# Kubernetes-in-Docker
7169
docker run --runtime=sysbox-runc -d --name k8s-node kindest/node:latest
7270
```
7371

@@ -106,15 +104,15 @@ installer/
106104
1. **Checks existing installation** - Prompts before overwriting
107105
2. **Copies binaries** - Places Sysbox binaries in `/tmp/` (writable location)
108106
3. **Sets up /etc overlay** - Creates persistent overlay preserving existing configs
109-
4. **Creates symlinks** - Links rsync, modprobe, iptables for Sysbox requirements
107+
4. **Creates symlinks** - Links rsync, modprobe, iptables for Sysbox requirements
110108
5. **Configures Docker** - Adds sysbox-runc runtime to Docker daemon
111109
6. **Creates systemd services** - Installs proper service files with dependencies
112110
7. **Starts services** - Enables and starts Sysbox daemons
113111
8. **Tests installation** - Verifies basic and Docker-in-Docker functionality
114112

115113
### Data Locations
116114

117-
- **Sysbox data**: `/dstack/persistent/sysbox-data`
115+
- **Sysbox data**: `/dstack/persistent/sysbox-data`
118116
- **Overlay data**: `/dstack/persistent/sysbox-etc-overlay`
119117
- **Binaries**: `/tmp/sysbox-*` and `/tmp/rsync-static`
120118

@@ -167,4 +165,4 @@ For issues with the installer, check:
167165
3. `/dstack/persistent/` is available and writable
168166
4. systemd is available on the host
169167

170-
For Sysbox issues, see: https://github.com/nestybox/sysbox
168+
For Sysbox issues, see: https://github.com/nestybox/sysbox

0 commit comments

Comments
 (0)