docs sync - search index backups

4 files changed, 64 insertions, 26 deletions

diff --git a/docs/build/Running-Backups/Backups/index.html b/docs/build/Running-Backups/Backups/index.html
index aabe029..04d1ffe 100644
--- a/docs/build/Running-Backups/Backups/index.html
+++ b/docs/build/Running-Backups/Backups/index.html
@@ -655,6 +655,13 @@
   
 </li>
       
+        <li class="md-nav__item">
+  <a href="#search-indexes" title="Search Indexes" class="md-nav__link">
+    Search Indexes
+  </a>
+  
+</li>
+      
       
       
     </ul>
@@ -785,6 +792,13 @@
   
 </li>
       
+        <li class="md-nav__item">
+  <a href="#search-indexes" title="Search Indexes" class="md-nav__link">
+    Search Indexes
+  </a>
+  
+</li>
+      
       
       
     </ul>
@@ -814,12 +828,21 @@
 
 
 <h2 id="uploads">Uploads<a class="headerlink" href="#uploads" title="Permanent link">&para;</a></h2>
-<p>The <code>/uploads</code> directory is gzip compressed and archived as a tar file, stored in the temporary directory (typically <code>/tmp</code> on Linux) on your origin server with a timestamp in the file name. </p>
+<p>The <code>uploads</code> directory is gzip compressed and archived as a tar file, stored in the temporary directory (typically <code>/tmp</code> on Linux) on your origin server with a timestamp in the file name. It is removed after the HTTP response for the backup has been written.</p>
 <p>An example backup request for the <code>/uploads</code> directory would look like:</p>
 <div class="codehilite"><pre><span></span>$ curl --user user:pass <span class="s2">&quot;https://example.com/admin/backup?source=uploads&quot;</span> &gt; uploads.tar.gz
 <span class="c1"># unarchive the tarball with gzip </span>
 $ tar xzf uploads.tar.gz
 </pre></div>
+
+
+<h2 id="search-indexes">Search Indexes<a class="headerlink" href="#search-indexes" title="Permanent link">&para;</a></h2>
+<p>The <code>search</code> directory, which is created to store the various search indexes for your content types (only if they implement <code>search.Searchable</code>), is backed up in the same fashion as <a href="../../Running-Backups/Backups/#uploads">Uploads</a>. </p>
+<p>An example backup request for the <code>/search</code> directory would look like:</p>
+<div class="codehilite"><pre><span></span>$ curl --user user:pass <span class="s2">&quot;https://example.com/admin/backup?source=search&quot;</span> &gt; search.tar.gz
+<span class="c1"># unarchive the tarball with gzip </span>
+$ tar xzf search.tar.gz
+</pre></div>
                 
                   
                 
diff --git a/docs/build/mkdocs/search_index.json b/docs/build/mkdocs/search_index.json
index b115dd1..8cfb301 100644
--- a/docs/build/mkdocs/search_index.json
+++ b/docs/build/mkdocs/search_index.json
@@ -997,7 +997,7 @@
         }, 
         {
             "location": "/Running-Backups/Backups/", 
-            "text": "Both the databases \nsystem.db\n \n \nanalytics.db\n, and the \n/uploads\n directory can be backed up over HTTP using \nwget\n, \ncurl\n, etc. All of which are located at the \n/admin/backup\n route and require HTTP Basic Auth. In order to enable backups, you must add a user/password pair inside the CMS Configuration at \n/admin/configure\n near the bottom of the page.\n\n\nAll backups are made using a \nGET\n request to the \n/admin/backup\n path with a query parameter of \n?source={system,analytics,uploads}\n (only one source can be included in the URL).\n\n\nHere are some full backup scripts to use or modify to fit your needs:\n\nhttps://github.com/ponzu-cms/backup-scripts\n\n\nSystem \n Analytics\n\n\nThe \nsystem.db\n \n \nanalytics.db\n data files are sent uncompressed in their original form as they exist on your server. No temporary copy is stored on the origin server, and it is possible that the backup could fail so checking for successful backups is recommended. See https://github.com/boltdb/bolt#database-backups for more information about how BoltDB handles HTTP backups.\n\n\nAn example backup request for the \nsystem.db\n data file would look like:\n\n\n$ curl --user user:pass \nhttps://example.com/admin/backup?source=system\n \n system.db.bak\n\n\n\n\n\nUploads\n\n\nThe \n/uploads\n directory is gzip compressed and archived as a tar file, stored in the temporary directory (typically \n/tmp\n on Linux) on your origin server with a timestamp in the file name. \n\n\nAn example backup request for the \n/uploads\n directory would look like:\n\n\n$ curl --user user:pass \nhttps://example.com/admin/backup?source=uploads\n \n uploads.tar.gz\n\n# unarchive the tarball with gzip \n\n$ tar xzf uploads.tar.gz", 
+            "text": "Both the databases \nsystem.db\n \n \nanalytics.db\n, and the \n/uploads\n directory can be backed up over HTTP using \nwget\n, \ncurl\n, etc. All of which are located at the \n/admin/backup\n route and require HTTP Basic Auth. In order to enable backups, you must add a user/password pair inside the CMS Configuration at \n/admin/configure\n near the bottom of the page.\n\n\nAll backups are made using a \nGET\n request to the \n/admin/backup\n path with a query parameter of \n?source={system,analytics,uploads}\n (only one source can be included in the URL).\n\n\nHere are some full backup scripts to use or modify to fit your needs:\n\nhttps://github.com/ponzu-cms/backup-scripts\n\n\nSystem \n Analytics\n\n\nThe \nsystem.db\n \n \nanalytics.db\n data files are sent uncompressed in their original form as they exist on your server. No temporary copy is stored on the origin server, and it is possible that the backup could fail so checking for successful backups is recommended. See https://github.com/boltdb/bolt#database-backups for more information about how BoltDB handles HTTP backups.\n\n\nAn example backup request for the \nsystem.db\n data file would look like:\n\n\n$ curl --user user:pass \nhttps://example.com/admin/backup?source=system\n \n system.db.bak\n\n\n\n\n\nUploads\n\n\nThe \nuploads\n directory is gzip compressed and archived as a tar file, stored in the temporary directory (typically \n/tmp\n on Linux) on your origin server with a timestamp in the file name. It is removed after the HTTP response for the backup has been written.\n\n\nAn example backup request for the \n/uploads\n directory would look like:\n\n\n$ curl --user user:pass \nhttps://example.com/admin/backup?source=uploads\n \n uploads.tar.gz\n\n# unarchive the tarball with gzip \n\n$ tar xzf uploads.tar.gz\n\n\n\n\n\nSearch Indexes\n\n\nThe \nsearch\n directory, which is created to store the various search indexes for your content types (only if they implement \nsearch.Searchable\n), is backed up in the same fashion as \nUploads\n. \n\n\nAn example backup request for the \n/search\n directory would look like:\n\n\n$ curl --user user:pass \nhttps://example.com/admin/backup?source=search\n \n search.tar.gz\n\n# unarchive the tarball with gzip \n\n$ tar xzf search.tar.gz", 
             "title": "Backups"
         }, 
         {
@@ -1007,10 +1007,15 @@
         }, 
         {
             "location": "/Running-Backups/Backups/#uploads", 
-            "text": "The  /uploads  directory is gzip compressed and archived as a tar file, stored in the temporary directory (typically  /tmp  on Linux) on your origin server with a timestamp in the file name.   An example backup request for the  /uploads  directory would look like:  $ curl --user user:pass  https://example.com/admin/backup?source=uploads    uploads.tar.gz # unarchive the tarball with gzip  \n$ tar xzf uploads.tar.gz", 
+            "text": "The  uploads  directory is gzip compressed and archived as a tar file, stored in the temporary directory (typically  /tmp  on Linux) on your origin server with a timestamp in the file name. It is removed after the HTTP response for the backup has been written.  An example backup request for the  /uploads  directory would look like:  $ curl --user user:pass  https://example.com/admin/backup?source=uploads    uploads.tar.gz # unarchive the tarball with gzip  \n$ tar xzf uploads.tar.gz", 
             "title": "Uploads"
         }, 
         {
+            "location": "/Running-Backups/Backups/#search-indexes", 
+            "text": "The  search  directory, which is created to store the various search indexes for your content types (only if they implement  search.Searchable ), is backed up in the same fashion as  Uploads .   An example backup request for the  /search  directory would look like:  $ curl --user user:pass  https://example.com/admin/backup?source=search    search.tar.gz # unarchive the tarball with gzip  \n$ tar xzf search.tar.gz", 
+            "title": "Search Indexes"
+        }, 
+        {
             "location": "/System-Configuration/Settings/", 
             "text": "Ponzu has several options which can be configured at run-time. To view these\nconfiguration settings, visit the \n/admin/configure\n page of your Ponzu CMS.\n\n\n\n\nSite Name\n\n\nThe Site Name setting changes the displayed name on your admin dashboard. This is\nvisible publicly on the \n/admin/login\n page.\n\n\n\n\nDomain Name\n\n\nInternally, Ponzu needs to know where its canonical HTTP access origin is, and\nrequires you to add the qualified domain name you are using. In development, use \n\nlocalhost\n or some other name mapped to the loopback address (\n127.0.0.1\n).\n\n\nOnce you have deployed your Ponzu server to a remote host and pointed a public \ndomain at it, you need to change the Domain Name setting to match. This is \nespecially important when fetching TLS (SSL) certificates from \nLet's Encrypt\n\n- since the process requires an active, verifiable domain. To set up your server\nwith TLS over HTTPS connections, follow these steps:\n\n\n\n\nSet your Domain Name in the system configuration\n\n\nSet the Administrator Email to register with Let's Encrypt\n\n\nStop your Ponzu server\n\n\nRun your Ponzu server with the \n--https\n flag e.g. \n$ ponzu run --https\n\n\nVisit your CMS admin with \nhttps://\n prepended to your URL\n\n\n\n\n\n\nVerifying HTTPS / TLS Connections\n\n\nIf successful, your APIs and CMS will be accessible via HTTPS, and you will\nsee a green indicator near the URL bar of most browsers. This also enables \nyour server to use the HTTP/2 protocol.\n\n\n\n\nDevelopment Environment\n\n\nYou can test HTTPS \n HTTP/2 connections in your development environment on \nlocalhost\n,\nby running Ponzu with the \n--devhttps\n flag e.g. \n$ ponzu --devhttps run\n \n\n\nIf you're greeted with a warning from the browser saying the connection is not\nsecure, follow the steps outlined in the CLI message, or here:\n\n\nIf your browser rejects HTTPS requests, try allowing insecure connections on localhost.\non Chrome, visit chrome://flags/#allow-insecure-localhost\n\n\n\n\n\n\n\nAdministrator Email\n\n\nThe Administrator Email is the contact email for the person who is the main admin\nof your Ponzu CMS. This can be changed at any point, but once a Let's Encrypt\ncertificate has been fetched using an Administrator Email, it will remain the \ncontact until a new certificate is requested. \n\n\n\n\nClient Secret\n\n\nThe Client Secret is a secure value used by the server to sign tokens and authenticate requests.\n\nDo not share this\n value with any untrusted party.\n\n\n\n\nSecurity and the Client Secret\n\n\nHTTP requests with a valid token, signed with the Client Secret, can take any\naction an Admin can within the CMS. Be cautious of this when sharing account\nlogins or details with anyone.\n\n\n\n\n\n\nEtag Header\n\n\nThe Etag Header value is automatically created when content is changed and serves\nas a caching validation mechanism.\n\n\n\n\nCORS\n\n\nCORS, or \"Cross-Origin Resource Sharing\" is a security setting which defines how\nresources (or URLs) can be accessed from outside clients / domains. By default, \nPonzu HTTP APIs can be accessed from any origin, meaning a script from an unknown\nwebsite could fetch data. \n\n\nBy disabling CORS, you limit API requests to only the Domain Name you set.\n\n\n\n\nGZIP\n\n\nGZIP is a popular codec which when applied to most HTTP responses, decreases data\ntransmission size and response times. The GZIP setting on Ponzu has a minor \nside-effect of using more CPU, so you can disable it if you notice your system \nis CPU-constrained. However, traffic levels would need to be extremely demanding\nfor this to be noticeable.\n\n\n\n\nHTTP Cache\n\n\nThe HTTP Cache configuration allows a system to disable the default HTTP cache,\nwhich saves the server from repeating API queries and sending responses -- it's\ngenerally advised to keep this enabled unless you have \nfrequently\n changing data.\n\n\nThe \nMax-Age\n value setting overrides the default 2592000-second (30 day) cache\n\nmax-age\n duration set in API response headers. The \n0\n value is an alias to \n\n2592000\n, so check the \nDisable HTTP Cache\n box if you don't want any caching.\n\n\n\n\nInvalidate Cache\n\n\nIf this box is checked and then the configuration is saved, the server will \nre-generate an Etag to send in responses. By doing so, the cache becomes invalidated\nand reset so new content or assets will be included in previously cached responses.\n\n\nThe cache is invalidated when content changes, so this is typically not a widely \nused setting.\n\n\n\n\nDatabase Backup Credentials\n\n\nIn order to enable HTTP backups of the components that make up your system, you\nwill need to add an HTTP Basic Auth user and password pair. When used to \n\nrun backups\n, the \nuser:password\n pair tells your server\nthat the backup request is made from a trusted party. \n\n\n\n\nBackup Access with Credentials\n\n\nThis \nuser:password\n pair should not be shared outside of your organization as \nit allows full database downloads and archives of your system's uploads.", 
             "title": "Settings"
diff --git a/docs/build/sitemap.xml b/docs/build/sitemap.xml
index 300b804..1e67040 100644
--- a/docs/build/sitemap.xml
+++ b/docs/build/sitemap.xml
@@ -4,7 +4,7 @@
     
     <url>
      <loc>/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
     
@@ -13,13 +13,13 @@
         
     <url>
      <loc>/CLI/General-Usage/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
     <url>
      <loc>/CLI/Generating-References/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
@@ -29,13 +29,13 @@
         
     <url>
      <loc>/Content/An-Overview/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
     <url>
      <loc>/Content/Extending-Content/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
@@ -45,7 +45,7 @@
         
     <url>
      <loc>/Form-Fields/HTML-Inputs/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
@@ -55,19 +55,19 @@
         
     <url>
      <loc>/HTTP-APIs/Content/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
     <url>
      <loc>/HTTP-APIs/File-Metadata/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
     <url>
      <loc>/HTTP-APIs/Search/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
@@ -77,31 +77,31 @@
         
     <url>
      <loc>/Interfaces/API/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
     <url>
      <loc>/Interfaces/Editor/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
     <url>
      <loc>/Interfaces/Format/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
     <url>
      <loc>/Interfaces/Item/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
     <url>
      <loc>/Interfaces/Search/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
@@ -111,13 +111,13 @@
         
     <url>
      <loc>/Ponzu-Addons/Creating-Addons/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
     <url>
      <loc>/Ponzu-Addons/Using-Addons/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
@@ -127,7 +127,7 @@
         
     <url>
      <loc>/Quickstart/Overview/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
@@ -137,7 +137,7 @@
         
     <url>
      <loc>/References/Overview/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
@@ -147,7 +147,7 @@
         
     <url>
      <loc>/Running-Backups/Backups/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
@@ -157,7 +157,7 @@
         
     <url>
      <loc>/System-Configuration/Settings/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
@@ -167,13 +167,13 @@
         
     <url>
      <loc>/System-Deployment/Docker/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
     <url>
      <loc>/System-Deployment/SysV-Style/</loc>
-     <lastmod>2017-06-10</lastmod>
+     <lastmod>2017-06-27</lastmod>
      <changefreq>daily</changefreq>
     </url>
         
diff --git a/docs/src/Running-Backups/Backups.md b/docs/src/Running-Backups/Backups.md
index 15632a0..fde0cab 100644
--- a/docs/src/Running-Backups/Backups.md
+++ b/docs/src/Running-Backups/Backups.md
@@ -16,11 +16,21 @@ $ curl --user user:pass "https://example.com/admin/backup?source=system" > syste
 ```
 
 ## Uploads
-The `/uploads` directory is gzip compressed and archived as a tar file, stored in the temporary directory (typically `/tmp` on Linux) on your origin server with a timestamp in the file name. 
+The `uploads` directory is gzip compressed and archived as a tar file, stored in the temporary directory (typically `/tmp` on Linux) on your origin server with a timestamp in the file name. It is removed after the HTTP response for the backup has been written.
 
 An example backup request for the `/uploads` directory would look like:
 ```bash
 $ curl --user user:pass "https://example.com/admin/backup?source=uploads" > uploads.tar.gz
 # unarchive the tarball with gzip 
 $ tar xzf uploads.tar.gz
+```
+
+## Search Indexes
+The `search` directory, which is created to store the various search indexes for your content types (only if they implement `search.Searchable`), is backed up in the same fashion as [Uploads](/Running-Backups/Backups/#uploads). 
+
+An example backup request for the `/search` directory would look like:
+```bash
+$ curl --user user:pass "https://example.com/admin/backup?source=search" > search.tar.gz
+# unarchive the tarball with gzip 
+$ tar xzf search.tar.gz
 ```
\ No newline at end of file