From 754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 Mon Sep 17 00:00:00 2001
From: Craig Jennings <c@cjennings.net>
Date: Sun, 7 Apr 2024 13:41:34 -0500
Subject: new repository

---
 devdocs/vagrant/synced-folders%2Frsync.html | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 devdocs/vagrant/synced-folders%2Frsync.html

(limited to 'devdocs/vagrant/synced-folders%2Frsync.html')

diff --git a/devdocs/vagrant/synced-folders%2Frsync.html b/devdocs/vagrant/synced-folders%2Frsync.html
new file mode 100644
index 00000000..6e38d611
--- /dev/null
+++ b/devdocs/vagrant/synced-folders%2Frsync.html
@@ -0,0 +1,22 @@
+<h1 id="rsync">  RSync </h1> <p><strong>Synced folder type:</strong> <code>rsync</code></p> <p>Vagrant can use <a href="https://en.wikipedia.org/wiki/Rsync">rsync</a> as a mechanism to sync a folder to the guest machine. This synced folder type is useful primarily in situations where other synced folder mechanisms are not available, such as when NFS or VirtualBox shared folders are not available in the guest machine.</p> <p>The rsync synced folder does a one-time one-way sync from the machine running to the machine being started by Vagrant.</p> <p>The <a href="../cli/rsync">rsync</a> and <a href="../cli/rsync-auto">rsync-auto</a> commands can be used to force a resync and to automatically resync when changes occur in the filesystem. Without running these commands, Vagrant only syncs the folders on <code>vagrant up</code> or <code>vagrant reload</code>.</p> <h2 id="prerequisites">  Prerequisites </h2> <p>To use the rsync synced folder type, the machine running Vagrant must have <code>rsync</code> (or <code>rsync.exe</code>) on the path. This executable is expected to behave like the standard rsync tool.</p> <p>On Windows, rsync installed with Cygwin or MinGW will be detected by Vagrant and works well.</p> <p>The destination machine must also have rsync installed, but Vagrant can automatically install rsync into many operating systems. If Vagrant is unable to automatically install rsync for your operating system, it will tell you.</p> <p>The destination folder will be created as the user initiating the connection, this is <code>vagrant</code> by default. This user requires the appropriate permissions on the destination folder.</p> <h2 id="options">  Options </h2> <p>The rsync synced folder type accepts the following options:</p> <ul> <li>
+<p><a href="#rsync__args"><code>rsync__args</code></a> (array of strings) - A list of arguments to supply to <code>rsync</code>. By default this is <code>["--verbose", "--archive", "--delete", "-z", "--copy-links"]</code>.</p> </li> <li>
+<p><a href="#rsync__auto"><code>rsync__auto</code></a> (boolean) - If false, then <code>rsync-auto</code> will not watch and automatically sync this folder. By default, this is true. <strong>Note</strong>: This option will not automatically invoke the <code>rsync-auto</code> subcommand.</p> </li> <li>
+<p><a href="#rsync__chown"><code>rsync__chown</code></a> (boolean) - If false, then the <a href="basic_usage"><code>owner</code> and <code>group</code></a> options for the synced folder are ignored and Vagrant will not execute a recursive <code>chown</code>. This defaults to true. This option exists because the <code>chown</code> causes issues for some development environments. Note that any <code>rsync__args</code> options for ownership <strong>will be overridden</strong> by <code>rsync__chown</code>.</p> </li> <li>
+<p><a href="#rsync__exclude"><code>rsync__exclude</code></a> (string or array of strings) - A list of files or directories to exclude from the sync. The values can be any acceptable rsync exclude pattern. By default, the ".vagrant/" directory is excluded. We recommend excluding revision control directories such as ".git/" as well.</p> </li> <li>
+<p><a href="#rsync__rsync_path"><code>rsync__rsync_path</code></a> (string) - The path on the remote host where rsync is and how it is executed. This is platform specific but defaults to "sudo rsync" for many guests.</p> </li> <li>
+<p><a href="#rsync__verbose"><code>rsync__verbose</code></a> (boolean) - If true, then the output from the rsync process will be echoed to the console. The output of rsync is subject to <code>rsync__args</code> of course. By default, this is false.</p> </li> </ul> <h2 id="example">  Example </h2> <p>The following is an example of using RSync to sync a folder:</p> <div class="highlight"><pre class="highlight ruby" data-language="ruby">Vagrant.configure("2") do |config|
+  config.vm.synced_folder ".", "/vagrant", type: "rsync",
+    rsync__exclude: ".git/"
+end
+</pre></div>
+<h2 id="rsync-to-a-restricted-folder">  Rsync to a restricted folder </h2> <p>If required to copy to a destination where <code>vagrant</code> user does not have permissions, use <code>"--rsync-path='sudo rsync'"</code> to run rsync with sudo on the guest</p> <div class="highlight"><pre class="highlight ruby" data-language="ruby">Vagrant.configure("2") do |config|
+  config.vm.synced_folder "bin", "/usr/local/bin", type: "rsync",
+    rsync__exclude: ".git/",
+    rsync__args: ["--verbose", "--rsync-path='sudo rsync'", "--archive", "--delete", "-z"]
+end
+</pre></div><div class="_attribution">
+  <p class="_attribution-p">
+    &copy; 2010&ndash;2018 Mitchell Hashimoto<br>Licensed under the MPL 2.0 License.<br>
+    <a href="https://www.vagrantup.com/docs/synced-folders/rsync.html" class="_attribution-link">https://www.vagrantup.com/docs/synced-folders/rsync.html</a>
+  </p>
+</div>
-- 
cgit v1.2.3