From f1e091e1460a56b0934379e529454ac956a9f456 Mon Sep 17 00:00:00 2001 From: Andrew David Wong Date: Thu, 15 Sep 2016 13:14:38 -0700 Subject: [PATCH] Add title and fix heading levels --- customization/bind-dirs.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/customization/bind-dirs.md b/customization/bind-dirs.md index 94341e64..7a8a1eb7 100644 --- a/customization/bind-dirs.md +++ b/customization/bind-dirs.md @@ -6,20 +6,22 @@ redirect_from: - /en/doc/bind-dirs/ --- -# What is bind-dirs.sh? # +# How to make any file in a TemplateBasedVM persistent using bind-dirs # + +## What is bind-dirs.sh? ## With [bind-dirs.sh](https://github.com/QubesOS/qubes-core-agent-linux/blob/master/vm-systemd/bind-dirs.sh) you can make arbitrary files or folders persistent in TemplateBasedVMs. -# What is it useful for? # +## What is it useful for? ## For example, it is useful for Whonix, sys-whonix, where [Tor's data dir /var/lib/tor has been made persistent in the TemplateBased ProxyVM sys-whonix](https://github.com/Whonix/qubes-whonix/blob/8438d13d75822e9ea800b9eb6024063f476636ff/usr/lib/qubes-bind-dirs.d/40_qubes-whonix.conf#L5). So sys-whonix does not require to be a StandaloneVM. And therefore can benefit from the Tor anonymity feature 'persistent Tor entry guards' without the overhead of a StandaloneVM. -# Minimum Qubes Version # +## Minimum Qubes Version ## bind-dirs.sh works with Qubes R3.2 and above. -# How to use bind-dirs.sh? # +## How to use bind-dirs.sh? ## 1) Create a file `/rw/config/qubes-bind-dirs.d/50_user.conf` with root rights inside a VM. @@ -35,20 +37,20 @@ binds+=( '/var/lib/tor' ) 5) Done. -# Other Configuration Folders # +## Other Configuration Folders ## * `/usr/lib/qubes-bind-dirs.d` (lowest priority, for packages) * `/etc/qubes-bind-dirs.d` (intermediate priority, for template wide configuration) * `/rw/config/qubes-bind-dirs.d` (highest priority, for per VM configuration) -# Limitations # +## Limitations ## * Files that exist in the TempalteVM root image cannot be made deleted in the TemlateBasedVMs root image using bind-dirs.sh. * Does not work if the file / folder in question does not already exist in the root image. I.e. a file that does not exist in the root image cannot be bind mounted in the TemplateBasedVM. * Re-running `sudo /usr/lib/qubes/bind-dirs.sh` without previous `sudo /usr/lib/qubes/bind-dirs.sh umount` does not work. * Running 'sudo /usr/lib/qubes/bind-dirs.sh umount' after boot (before shutdown) is probably not sane and nothing can be done about that. -# How to remove binds from bind-dirs.sh? # +## How to remove binds from bind-dirs.sh? ## `binds` is actually just a bash variable (an array) and the bind-dirs.sh configuration folders are `source`d as bash snippets in lexical order. Therefore if you wanted to remove an existing entry from the `binds` array, you could do that by using a lexically higher configuration file. For example, if you wanted to make `/var/lib/tor` non-persistant in `sys-whonix` without manually editing [`/usr/lib/qubes-bind-dirs.d/40_qubes-whonix.conf`](https://github.com/Whonix/qubes-whonix/blob/master/usr/lib/qubes-bind-dirs.d/40_qubes-whonix.conf), you could use the following. @@ -60,7 +62,7 @@ binds=( "${binds[@]/'/var/lib/tor'}" ) (Editing `/usr/lib/qubes-bind-dirs.d/40_qubes-whonix.conf` directly is recommended against, since such changes get lost when that file is changed in the package on upgrades.) -# Discussion # +## Discussion ## [TemplateBasedVMs: make selected files and folders located in the root image persistent- review bind-dirs.sh](https://groups.google.com/forum/#!searchin/qubes-devel/bind-dirs|sort:relevance/qubes-devel/tcYQ4eV-XX4/J89DRLzOBQAJ)