]> git.proxmox.com Git - mirror_lxcfs.git/blob - README.md
Fix formatting of README
[mirror_lxcfs.git] / README.md
1 # lxcfs
2
3 ## Introduction
4 FUSE filesystem for LXC, offering the following features:
5 - a cgroupfs compatible view for unprivileged containers
6 - a set of cgroup-aware files:
7 - cpuinfo
8 - meminfo
9 - stat
10 - uptime
11
12 ## Usage
13 The recommended command to run lxcfs is:
14
15 sudo mkdir -p /var/lib/lxcfs
16 sudo lxcfs -s -f -o allow_other /var/lib/lxcfs
17
18 - -s is required to turn off multi-threading as libnih-dbus isn't thread safe.
19 - -f is to keep lxcfs running in the foreground
20 - -o allow\_other is required to have non-root user be able to access the filesystem
21 - -d can also be passed in order to debug lxcfs
22
23
24 In order to use lxcfs with systemd-based containers, you can either use
25 LXC 1.1 in which case it should work automatically, or otherwise, copy
26 the lxc.mount.hook file (once built) from this tree to
27 /usr/share/lxc/hooks/lxcfs, make sure it is executable, then add the
28 following two lines to your container configuration:
29 ```
30 lxc.autodev = 1
31 lxc.kmsg = 0
32 lxc.include = /usr/share/lxcfs/00-lxc.conf
33 ```