]> git.proxmox.com Git - mirror_lxcfs.git/commitdiff
Update README
authorStéphane Graber <stgraber@ubuntu.com>
Sat, 27 Dec 2014 10:37:00 +0000 (11:37 +0100)
committerStéphane Graber <stgraber@ubuntu.com>
Sat, 27 Dec 2014 10:37:00 +0000 (11:37 +0100)
Signed-off-by: Stéphane Graber <stgraber@ubuntu.com>
README.md

index b2ac4f4dac5b1bde4a6c3202a41cbaa6235e5c6b..8e11f7278a395218fa3df2bb5c83572b74844c5c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
 # lxcfs
 
+## Introduction
 FUSE filesystem for LXC, offering the following features:
  - a cgroupfs compatible view for unprivileged containers
  - a set of cgroup-aware files:
@@ -8,12 +9,13 @@ FUSE filesystem for LXC, offering the following features:
    - stat
    - uptime
 
-### Usage
-
+## Usage
 The recommended command to run lxcfs is:
 
-       sudo mkdir -p /var/lib/lxcfs
-       sudo lxcfs -s -f -d -o allow_other /var/lib/lxcfs
+    sudo mkdir -p /var/lib/lxcfs
+    sudo lxcfs -s -f -o allow_other /var/lib/lxcfs
 
-We recommend -s to avoid threading;  -o allow_other is needed to
-allow users other than root to use the filesystem.
+ - -s is required to turn off multi-threading as libnih-dbus isn't thread safe.
+ - -f is to keep lxcfs running in the foreground
+ - -o allow\_other is required to have non-root user be able to access the filesystem
+ - -d can also be passed in order to debug lxcfs