Merge pull request #87 from hallyn/2016-02-23/init

[mirror_lxcfs.git] / README.md

diff --git a/README.md b/README.md
index b2ac4f4dac5b1bde4a6c3202a41cbaa6235e5c6b..b307d8f91ef65f3385bd0d71692b7b5f383cc0dc 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,22 @@ FUSE filesystem for LXC, offering the following features:
    - stat
    - uptime
 
-### Usage
+In other words, it will provide an emulated `/proc` and `/sys/fs/cgroup` folder for the containers.
 
+## 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 /var/lib/lxcfs
 
-We recommend -s to avoid threading;  -o allow_other is needed to
-allow users other than root to use the filesystem.
+In order to use lxcfs with systemd-based containers, you can either use
+LXC 1.1 in which case it should work automatically, or otherwise, copy
+the `lxc.mount.hook` and `lxc.reboot.hook` files (once built) from this tree to
+`/usr/share/lxcfs`, make sure it is executable, then add the
+following lines to your container configuration:
+```
+lxc.mount.auto = cgroup:mixed
+lxc.autodev = 1
+lxc.kmsg = 0
+lxc.include = /usr/share/lxc/config/common.conf.d/00-lxcfs.conf
+```