@@ -154,78 +154,83 @@ USAGE:
154
154
rootlesskit [global options] [arguments...]
155
155
156
156
VERSION:
157
- 1.1 .0
157
+ 2.0.0-alpha .0
158
158
159
159
DESCRIPTION:
160
160
RootlessKit is a Linux-native implementation of "fake root" using user_namespaces(7).
161
-
161
+
162
162
Web site: https://github.com/rootless-containers/rootlesskit
163
-
163
+
164
164
Examples:
165
165
# spawn a shell with a new user namespace and a mount namespace
166
166
rootlesskit bash
167
-
167
+
168
168
# make /etc writable
169
169
rootlesskit --copy-up=/etc bash
170
-
170
+
171
171
# set mount propagation to rslave
172
172
rootlesskit --propagation=rslave bash
173
-
173
+
174
174
# create a network namespace with slirp4netns, and expose 80/tcp on the namespace as 8080/tcp on the host
175
175
rootlesskit --copy-up=/etc --net=slirp4netns --disable-host-loopback --port-driver=builtin -p 127.0.0.1:8080:80/tcp bash
176
-
176
+
177
177
Note: RootlessKit requires /etc/subuid and /etc/subgid to be configured by the real root user.
178
178
See https://rootlesscontaine.rs/getting-started/common/ .
179
179
180
180
OPTIONS:
181
- Misc:
181
+ Misc:
182
182
--debug debug mode (default: false)
183
- --help, -h show help (default: false)
184
- --version, -v print the version (default: false)
185
-
186
- Mount:
183
+ --print-semver value print a version component as a decimal integer [major, minor, patch]
184
+ --help, -h show help
185
+ --version, -v print the version
186
+
187
+ Mount:
187
188
--copy-up value [ --copy-up value ] mount a filesystem and copy-up the contents. e.g. "--copy-up=/etc" (typically required for non-host network)
188
189
--copy-up-mode value copy-up mode [tmpfs+symlink]
189
190
--propagation value mount propagation [rprivate, rslave]
190
-
191
- Network:
192
- --net value network driver [host, slirp4netns, vpnkit, lxc-user-nic(experimental)]
193
- --mtu value MTU for non-host network (default: 65520 for slirp4netns, 1500 for others) (default: 0)
194
- --cidr value CIDR for slirp4netns network (default: 10.0.2.0/24)
195
- --ifname value Network interface name (default: tap0 for slirp4netns and vpnkit, eth0 for lxc-user-nic)
191
+
192
+ Network:
193
+ --net value network driver [host, pasta(experimental), slirp4netns, vpnkit, lxc-user-nic(experimental)]
194
+ --mtu value MTU for non-host network (default: 65520 for pasta and slirp4netns, 1500 for others) (default: 0)
195
+ --cidr value CIDR for pasta and slirp4netns networks (default: 10.0.2.0/24)
196
+ --ifname value Network interface name (default: tap0 for pasta, slirp4netns, and vpnkit; eth0 for lxc-user-nic)
196
197
--disable-host-loopback prohibit connecting to 127.0.0.1:* on the host namespace (default: false)
197
- --ipv6 enable IPv6 routing. Unrelated to port forwarding. Only supported for slirp4netns. (experimental) (default: false)
198
-
199
- Network [lxc-user-nic]:
198
+ --ipv6 enable IPv6 routing. Unrelated to port forwarding. Only supported for pasta and slirp4netns. (experimental) (default: false)
199
+ --detach-netns detach network namespaces (default: false)
200
+
201
+ Network [lxc-user-nic]:
200
202
--lxc-user-nic-binary value path of lxc-user-nic binary for --net=lxc-user-nic
201
203
--lxc-user-nic-bridge value lxc-user-nic bridge name
202
-
203
- Network [slirp4netns]:
204
+
205
+ Network [pasta]:
206
+ --pasta-binary value path of pasta binary for --net=pasta
207
+
208
+ Network [slirp4netns]:
204
209
--slirp4netns-binary value path of slirp4netns binary for --net=slirp4netns
205
210
--slirp4netns-sandbox value enable slirp4netns sandbox (experimental) [auto, true, false] (the default is planned to be "auto" in future)
206
211
--slirp4netns-seccomp value enable slirp4netns seccomp (experimental) [auto, true, false] (the default is planned to be "auto" in future)
207
-
208
- Network [vpnkit]:
212
+
213
+ Network [vpnkit]:
209
214
--vpnkit-binary value path of VPNKit binary for --net=vpnkit
210
-
211
- Port:
212
- --port-driver value port driver for non-host network. [none, builtin, slirp4netns]
215
+
216
+ Port:
217
+ --port-driver value port driver for non-host network. [none, implicit (for pasta), builtin, slirp4netns]
213
218
--publish value, -p value [ --publish value, -p value ] publish ports. e.g. "127.0.0.1:8080:80/tcp"
214
-
215
- Process:
219
+
220
+ Process:
216
221
--pidns create a PID namespace (default: false)
217
222
--cgroupns create a cgroup namespace (default: false)
218
223
--utsns create a UTS namespace (default: false)
219
224
--ipcns create an IPC namespace (default: false)
220
225
--reaper value enable process reaper. Requires --pidns. [auto,true,false]
221
226
--evacuate-cgroup2 value evacuate processes into the specified subgroup. Requires --pidns and --cgroupns
222
-
223
- State:
227
+
228
+ State:
224
229
--state-dir value state directory
225
-
226
- SubID:
230
+
231
+ SubID:
227
232
--subid-source value the source of the subids. "dynamic" executes /usr/bin/getsubids. "static" reads /etc/{subuid,subgid}. [auto,dynamic,static]
228
-
233
+
229
234
```
230
235
231
236
## State directory
0 commit comments