Add some information about the requirements of a chroot environment.
authorGuus Sliepen <guus@tinc-vpn.org>
Wed, 11 Oct 2017 17:30:17 +0000 (19:30 +0200)
committerGuus Sliepen <guus@tinc-vpn.org>
Wed, 11 Oct 2017 17:30:17 +0000 (19:30 +0200)
doc/tinc.texi

index cdccea5..db35b4a 100644 (file)
@@ -1743,10 +1743,14 @@ located (@file{@value{sysconfdir}/tinc/@var{netname}/} as determined by
 The chroot is performed after all the initialization is done, after
 writing pid files and opening network sockets.
 
 The chroot is performed after all the initialization is done, after
 writing pid files and opening network sockets.
 
-Note that this option alone does not do any good without -U/--user, below.
-
-Note also that tinc can't run scripts anymore (such as tinc-down or host-up),
-unless it's setup to be runnable inside chroot environment.
+This option is best used in combination with the -U/--user option described below.
+
+You will need to ensure the chroot environment contains all the files necessary
+for tinc to run correctly.
+Most importantly, for tinc to be able to resolve hostnames inside the chroot environment,
+you must copy @file{/etc/resolv.conf} into the chroot directory.
+If you want to be able to run scripts other than @file{tinc-up} in the chroot,
+you must ensure the appropriate shell is also installed in the chroot, along with all its dependencies.
 
 @item -U, --user=@var{user}
 Switch to the given @var{user} after initialization, at the same time as
 
 @item -U, --user=@var{user}
 Switch to the given @var{user} after initialization, at the same time as