qubes-doc/customization/bind-dirs.md

67 lines
3.3 KiB
Markdown
Raw Normal View History

---
layout: doc
2016-09-15 08:11:56 -04:00
title: How to make any file in a TemplateBasedVM persistent using bind-dirs
permalink: /doc/bind-dirs/
redirect_from:
- /en/doc/bind-dirs/
---
2016-09-15 16:14:38 -04:00
# 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.
2016-09-15 16:14:38 -04:00
## 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.
2016-09-15 16:14:38 -04:00
## Minimum Qubes Version ##
bind-dirs.sh works with Qubes R3.2 and above.
2016-09-15 16:14:38 -04:00
## How to use bind-dirs.sh? ##
2016-09-15 16:20:30 -04:00
1. Create a file `/rw/config/qubes-bind-dirs.d/50_user.conf` with root rights inside a VM.
2016-09-15 16:20:30 -04:00
2. Append a folder or file to the `binds` variable. In the following example we are using folder `/var/lib/tor`. You can replace that folder with a folder or file of your choice.
2016-09-15 16:20:30 -04:00
binds+=( '/var/lib/tor' )
2016-09-15 16:20:30 -04:00
3. Save.
2016-09-15 16:20:30 -04:00
4. Reboot the VM.
2016-09-15 16:20:30 -04:00
5. Done.
2016-09-15 16:14:38 -04:00
## 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)
2016-09-15 16:14:38 -04:00
## 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.
2016-09-15 16:14:38 -04:00
## 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.
`/rw/config/qubes-bind-dirs.d/50_user.conf`
2016-09-15 16:20:30 -04:00
~~~
binds=( "${binds[@]/'/var/lib/tor'}" )
2016-09-15 16:20:30 -04:00
~~~
(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.)
2016-09-15 16:14:38 -04:00
## Discussion ##
2016-09-15 16:21:04 -04:00
[TemplateBasedVMs: make selected files and folders located in the root image persistent- review bind-dirs.sh](https://groups.google.com/forum/#!topic/qubes-devel/tcYQ4eV-XX4/discussion)