diff options
| author | Steve Manuel <nilslice@gmail.com> | 2017-05-27 10:27:51 -0700 |
|---|---|---|
| committer | Steve Manuel <nilslice@gmail.com> | 2017-05-27 10:27:51 -0700 |
| commit | 78de7ed98abff93fe5fef94907bcfa4f76dcef07 (patch) | |
| tree | f58578554dc829a046762e588d8b190af89dd992 /docs/build/System-Configuration/Settings/index.html | |
| parent | 38aa0ebb1df97ff185d84da2d3c2f9a11888729b (diff) | |
adding docs to repo
Diffstat (limited to 'docs/build/System-Configuration/Settings/index.html')
| -rw-r--r-- | docs/build/System-Configuration/Settings/index.html | 1131 |
1 files changed, 1131 insertions, 0 deletions
diff --git a/docs/build/System-Configuration/Settings/index.html b/docs/build/System-Configuration/Settings/index.html new file mode 100644 index 0000000..cafc145 --- /dev/null +++ b/docs/build/System-Configuration/Settings/index.html @@ -0,0 +1,1131 @@ + +<!DOCTYPE html> +<html lang="en" class="no-js"> + <head> + + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width,initial-scale=1"> + + + + + <link rel="shortcut icon" href="../../assets/images/favicon.png"> + + <meta name="generator" content="mkdocs-0.16.3, mkdocs-material-1.6.1"> + + + + <title>Configuring Your Ponzu System Settings</title> + + + + <script src="../../assets/javascripts/modernizr-56ade86843.js"></script> + + + <link rel="stylesheet" href="../../assets/stylesheets/application-4d0d3f2fbf.css"> + + <link rel="stylesheet" href="../../assets/stylesheets/application-f78e5cb881.palette.css"> + + + + + + + + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono"> + <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style> + + <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons"> + + + + </head> + + + + + <body data-md-color-primary="grey" data-md-color-accent="light-blue"> + + <svg class="md-svg"> + <defs> + + + <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg> + + </defs> + </svg> + <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="drawer"> + <input class="md-toggle" data-md-toggle="search" type="checkbox" id="search"> + <label class="md-overlay" data-md-component="overlay" for="drawer"></label> + + <header class="md-header" data-md-component="header"> + <nav class="md-header-nav md-grid"> + <div class="md-flex"> + <div class="md-flex__cell md-flex__cell--shrink"> + + <a href="../.." title="Ponzu" class="md-logo md-header-nav__button"> + <img src="../../images/logo.png" width="24" height="24"> + </a> + + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + <label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label> + </div> + <div class="md-flex__cell md-flex__cell--stretch"> + <span class="md-flex__ellipsis md-header-nav__title"> + + + + <span class="md-header-nav__parent"> + System Configuration + </span> + + + Settings + + </span> + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + + <label class="md-icon md-icon--search md-header-nav__button" for="search"></label> + +<div class="md-search" data-md-component="search"> + <label class="md-search__overlay" for="search"></label> + <div class="md-search__inner"> + <form class="md-search__form" name="search"> + <input type="text" class="md-search__input" name="query" required placeholder="Search" accesskey="s" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query"> + <label class="md-icon md-search__icon" for="search"></label> + <button type="reset" class="md-icon md-search__icon" data-md-component="reset">close</button> + </form> + <div class="md-search__output"> + <div class="md-search__scrollwrap" data-md-scrollfix> + <div class="md-search-result" data-md-component="result"> + <div class="md-search-result__meta" data-md-lang-result-none="No matching documents" data-md-lang-result-one="1 matching document" data-md-lang-result-other="# matching documents"> + Type to start searching + </div> + <ol class="md-search-result__list"></ol> + </div> + </div> + </div> + </div> +</div> + + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + <div class="md-header-nav__source"> + + + + + + + + <a href="https://github.com/ponzu-cms/ponzu" title="Go to repository" class="md-source" data-md-source="github"> + + <div class="md-source__icon"> + <svg viewBox="0 0 24 24" width="24" height="24"> + <use xlink:href="#github" width="24" height="24"></use> + </svg> + </div> + + <div class="md-source__repository"> + ponzu-cms/ponzu + </div> + </a> + + + </div> + </div> + </div> + </nav> +</header> + + <div class="md-container"> + + + <main class="md-main"> + <div class="md-main__inner md-grid" data-md-component="container"> + + + <div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + <nav class="md-nav md-nav--primary" data-md-level="0"> + <label class="md-nav__title md-nav__title--site" for="drawer"> + + <i class="md-logo md-nav__button"> + <img src="../../images/logo.png"> + </i> + + Ponzu + </label> + + <div class="md-nav__source"> + + + + + + + <a href="https://github.com/ponzu-cms/ponzu" title="Go to repository" class="md-source" data-md-source="github"> + + <div class="md-source__icon"> + <svg viewBox="0 0 24 24" width="24" height="24"> + <use xlink:href="#github" width="24" height="24"></use> + </svg> + </div> + + <div class="md-source__repository"> + ponzu-cms/ponzu + </div> + </a> + + </div> + + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + <li class="md-nav__item"> + <a href="../.." title="Home" class="md-nav__link"> + Home + </a> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2"> + + <label class="md-nav__link" for="nav-2"> + CLI + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-2"> + CLI + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../../CLI/General-Usage/" title="General Usage" class="md-nav__link"> + General Usage + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../CLI/Generating-References/" title="Generating References" class="md-nav__link"> + Generating References + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3"> + + <label class="md-nav__link" for="nav-3"> + Content + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-3"> + Content + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../../Content/An-Overview/" title="An Overview" class="md-nav__link"> + An Overview + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../Content/Extending-Content/" title="Extending Content" class="md-nav__link"> + Extending Content + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4"> + + <label class="md-nav__link" for="nav-4"> + Form Fields + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-4"> + Form Fields + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../../Form-Fields/HTML-Inputs/" title="HTML Inputs" class="md-nav__link"> + HTML Inputs + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5"> + + <label class="md-nav__link" for="nav-5"> + HTTP APIs + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-5"> + HTTP APIs + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../../HTTP-APIs/Content/" title="Content" class="md-nav__link"> + Content + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../HTTP-APIs/File-Metadata/" title="File Metadata" class="md-nav__link"> + File Metadata + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../HTTP-APIs/Search/" title="Search" class="md-nav__link"> + Search + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6"> + + <label class="md-nav__link" for="nav-6"> + Interfaces + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-6"> + Interfaces + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../../Interfaces/API/" title="API" class="md-nav__link"> + API + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../Interfaces/Editor/" title="Editor" class="md-nav__link"> + Editor + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../Interfaces/Format/" title="Format" class="md-nav__link"> + Format + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../Interfaces/Item/" title="Item" class="md-nav__link"> + Item + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../Interfaces/Search/" title="Search" class="md-nav__link"> + Search + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7"> + + <label class="md-nav__link" for="nav-7"> + Ponzu Addons + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-7"> + Ponzu Addons + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../../Ponzu-Addons/Creating-Addons/" title="Creating Addons" class="md-nav__link"> + Creating Addons + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../Ponzu-Addons/Using-Addons/" title="Using Addons" class="md-nav__link"> + Using Addons + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8"> + + <label class="md-nav__link" for="nav-8"> + Quickstart + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-8"> + Quickstart + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../../Quickstart/Overview/" title="Overview" class="md-nav__link"> + Overview + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9"> + + <label class="md-nav__link" for="nav-9"> + References + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-9"> + References + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../../References/Overview/" title="Overview" class="md-nav__link"> + Overview + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10"> + + <label class="md-nav__link" for="nav-10"> + Running Backups + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-10"> + Running Backups + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../../Running-Backups/Backups/" title="Backups" class="md-nav__link"> + Backups + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + + + <li class="md-nav__item md-nav__item--active md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-11" type="checkbox" id="nav-11" checked> + + <label class="md-nav__link" for="nav-11"> + System Configuration + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-11"> + System Configuration + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + + + <li class="md-nav__item md-nav__item--active"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="toc"> + + + <label class="md-nav__link md-nav__link--active" for="toc"> + Settings + </label> + + <a href="./" title="Settings" class="md-nav__link md-nav__link--active"> + Settings + </a> + + +<nav class="md-nav md-nav--secondary"> + + + + <label class="md-nav__title" for="toc">Table of contents</label> + <ul class="md-nav__list" data-md-scrollfix> + + <li class="md-nav__item"> + <a href="#site-name" title="Site Name" class="md-nav__link"> + Site Name + </a> + +</li> + + <li class="md-nav__item"> + <a href="#domain-name" title="Domain Name" class="md-nav__link"> + Domain Name + </a> + + <nav class="md-nav"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#development-environment" title="Development Environment" class="md-nav__link"> + Development Environment + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#administrator-email" title="Administrator Email" class="md-nav__link"> + Administrator Email + </a> + +</li> + + <li class="md-nav__item"> + <a href="#client-secret" title="Client Secret" class="md-nav__link"> + Client Secret + </a> + +</li> + + <li class="md-nav__item"> + <a href="#etag-header" title="Etag Header" class="md-nav__link"> + Etag Header + </a> + +</li> + + <li class="md-nav__item"> + <a href="#cors" title="CORS" class="md-nav__link"> + CORS + </a> + +</li> + + <li class="md-nav__item"> + <a href="#gzip" title="GZIP" class="md-nav__link"> + GZIP + </a> + +</li> + + <li class="md-nav__item"> + <a href="#http-cache" title="HTTP Cache" class="md-nav__link"> + HTTP Cache + </a> + +</li> + + <li class="md-nav__item"> + <a href="#invalidate-cache" title="Invalidate Cache" class="md-nav__link"> + Invalidate Cache + </a> + +</li> + + <li class="md-nav__item"> + <a href="#database-backup-credentials" title="Database Backup Credentials" class="md-nav__link"> + Database Backup Credentials + </a> + +</li> + + + + </ul> + +</nav> + + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-12" type="checkbox" id="nav-12"> + + <label class="md-nav__link" for="nav-12"> + System Deployment + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-12"> + System Deployment + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../../System-Deployment/Docker/" title="Docker" class="md-nav__link"> + Docker + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../System-Deployment/SysV-Style/" title="SysV Style" class="md-nav__link"> + SysV Style + </a> + </li> + + + </ul> + </nav> + </li> + + + </ul> +</nav> + </div> + </div> + </div> + + + <div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + +<nav class="md-nav md-nav--secondary"> + + + + <label class="md-nav__title" for="toc">Table of contents</label> + <ul class="md-nav__list" data-md-scrollfix> + + <li class="md-nav__item"> + <a href="#site-name" title="Site Name" class="md-nav__link"> + Site Name + </a> + +</li> + + <li class="md-nav__item"> + <a href="#domain-name" title="Domain Name" class="md-nav__link"> + Domain Name + </a> + + <nav class="md-nav"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#development-environment" title="Development Environment" class="md-nav__link"> + Development Environment + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#administrator-email" title="Administrator Email" class="md-nav__link"> + Administrator Email + </a> + +</li> + + <li class="md-nav__item"> + <a href="#client-secret" title="Client Secret" class="md-nav__link"> + Client Secret + </a> + +</li> + + <li class="md-nav__item"> + <a href="#etag-header" title="Etag Header" class="md-nav__link"> + Etag Header + </a> + +</li> + + <li class="md-nav__item"> + <a href="#cors" title="CORS" class="md-nav__link"> + CORS + </a> + +</li> + + <li class="md-nav__item"> + <a href="#gzip" title="GZIP" class="md-nav__link"> + GZIP + </a> + +</li> + + <li class="md-nav__item"> + <a href="#http-cache" title="HTTP Cache" class="md-nav__link"> + HTTP Cache + </a> + +</li> + + <li class="md-nav__item"> + <a href="#invalidate-cache" title="Invalidate Cache" class="md-nav__link"> + Invalidate Cache + </a> + +</li> + + <li class="md-nav__item"> + <a href="#database-backup-credentials" title="Database Backup Credentials" class="md-nav__link"> + Database Backup Credentials + </a> + +</li> + + + + </ul> + +</nav> + </div> + </div> + </div> + + + <div class="md-content"> + <article class="md-content__inner md-typeset"> + + + + <h1>Settings</h1> + + <p>Ponzu has several options which can be configured at run-time. To view these +configuration settings, visit the <code>/admin/configure</code> page of your Ponzu CMS.</p> +<hr /> +<h4 id="site-name">Site Name<a class="headerlink" href="#site-name" title="Permanent link">¶</a></h4> +<p>The Site Name setting changes the displayed name on your admin dashboard. This is +visible publicly on the <code>/admin/login</code> page.</p> +<hr /> +<h4 id="domain-name">Domain Name<a class="headerlink" href="#domain-name" title="Permanent link">¶</a></h4> +<p>Internally, Ponzu needs to know where its canonical HTTP access origin is, and +requires you to add the qualified domain name you are using. In development, use +<code>localhost</code> or some other name mapped to the loopback address (<code>127.0.0.1</code>).</p> +<p>Once you have deployed your Ponzu server to a remote host and pointed a public +domain at it, you need to change the Domain Name setting to match. This is +especially important when fetching TLS (SSL) certificates from <a href="https://letsencrypt.org">Let's Encrypt</a> +- since the process requires an active, verifiable domain. To set up your server +with TLS over HTTPS connections, follow these steps:</p> +<ol> +<li>Set your Domain Name in the system configuration</li> +<li>Set the Administrator Email to register with Let's Encrypt</li> +<li>Stop your Ponzu server</li> +<li>Run your Ponzu server with the <code>--https</code> flag e.g. <code>$ ponzu run --https</code></li> +<li>Visit your CMS admin with <code>https://</code> prepended to your URL</li> +</ol> +<div class="admonition success"> +<p class="admonition-title">Verifying HTTPS / TLS Connections</p> +<p>If successful, your APIs and CMS will be accessible via HTTPS, and you will +see a green indicator near the URL bar of most browsers. This also enables +your server to use the HTTP/2 protocol.</p> +</div> +<h5 id="development-environment">Development Environment<a class="headerlink" href="#development-environment" title="Permanent link">¶</a></h5> +<p>You can test HTTPS & HTTP/2 connections in your development environment on <code>localhost</code>, +by running Ponzu with the <code>--devhttps</code> flag e.g. <code>$ ponzu --devhttps run</code> </p> +<p>If you're greeted with a warning from the browser saying the connection is not +secure, follow the steps outlined in the CLI message, or here:</p> +<div class="codehilite"><pre><span></span>If your browser rejects HTTPS requests, try allowing insecure connections on localhost. +on Chrome, visit chrome://flags/#allow-insecure-localhost +</pre></div> + + +<hr /> +<h4 id="administrator-email">Administrator Email<a class="headerlink" href="#administrator-email" title="Permanent link">¶</a></h4> +<p>The Administrator Email is the contact email for the person who is the main admin +of your Ponzu CMS. This can be changed at any point, but once a Let's Encrypt +certificate has been fetched using an Administrator Email, it will remain the +contact until a new certificate is requested. </p> +<hr /> +<h4 id="client-secret">Client Secret<a class="headerlink" href="#client-secret" title="Permanent link">¶</a></h4> +<p>The Client Secret is a secure value used by the server to sign tokens and authenticate requests. +<strong>Do not share this</strong> value with any untrusted party.</p> +<div class="admonition danger"> +<p class="admonition-title">Security and the Client Secret</p> +<p>HTTP requests with a valid token, signed with the Client Secret, can take any +action an Admin can within the CMS. Be cautious of this when sharing account +logins or details with anyone.</p> +</div> +<hr /> +<h4 id="etag-header">Etag Header<a class="headerlink" href="#etag-header" title="Permanent link">¶</a></h4> +<p>The Etag Header value is automatically created when content is changed and serves +as a caching validation mechanism.</p> +<hr /> +<h4 id="cors">CORS<a class="headerlink" href="#cors" title="Permanent link">¶</a></h4> +<p>CORS, or "Cross-Origin Resource Sharing" is a security setting which defines how +resources (or URLs) can be accessed from outside clients / domains. By default, +Ponzu HTTP APIs can be accessed from any origin, meaning a script from an unknown +website could fetch data. </p> +<p>By disabling CORS, you limit API requests to only the Domain Name you set.</p> +<hr /> +<h4 id="gzip">GZIP<a class="headerlink" href="#gzip" title="Permanent link">¶</a></h4> +<p>GZIP is a popular codec which when applied to most HTTP responses, decreases data +transmission size and response times. The GZIP setting on Ponzu has a minor +side-effect of using more CPU, so you can disable it if you notice your system +is CPU-constrained. However, traffic levels would need to be extremely demanding +for this to be noticeable.</p> +<hr /> +<h4 id="http-cache">HTTP Cache<a class="headerlink" href="#http-cache" title="Permanent link">¶</a></h4> +<p>The HTTP Cache configuration allows a system to disable the default HTTP cache, +which saves the server from repeating API queries and sending responses -- it's +generally advised to keep this enabled unless you have <em>frequently</em> changing data.</p> +<p>The <code>Max-Age</code> value setting overrides the default 2592000-second (30 day) cache +<code>max-age</code> duration set in API response headers. The <code>0</code> value is an alias to +<code>2592000</code>, so check the <code>Disable HTTP Cache</code> box if you don't want any caching.</p> +<hr /> +<h4 id="invalidate-cache">Invalidate Cache<a class="headerlink" href="#invalidate-cache" title="Permanent link">¶</a></h4> +<p>If this box is checked and then the configuration is saved, the server will +re-generate an Etag to send in responses. By doing so, the cache becomes invalidated +and reset so new content or assets will be included in previously cached responses.</p> +<p>The cache is invalidated when content changes, so this is typically not a widely +used setting.</p> +<hr /> +<h4 id="database-backup-credentials">Database Backup Credentials<a class="headerlink" href="#database-backup-credentials" title="Permanent link">¶</a></h4> +<p>In order to enable HTTP backups of the components that make up your system, you +will need to add an HTTP Basic Auth user and password pair. When used to +<a href="../../Running-Backups/Backups">run backups</a>, the <code>user:password</code> pair tells your server +that the backup request is made from a trusted party. </p> +<div class="admonition danger"> +<p class="admonition-title">Backup Access with Credentials</p> +<p>This <code>user:password</code> pair should not be shared outside of your organization as +it allows full database downloads and archives of your system's uploads.</p> +</div> + + + + + + + + </article> + </div> + </div> + </main> + + +<footer class="md-footer"> + + <div class="md-footer-nav"> + <nav class="md-footer-nav__inner md-grid"> + + <a href="../../Running-Backups/Backups/" title="Backups" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> + <div class="md-flex__cell md-flex__cell--shrink"> + <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> + </div> + <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> + <span class="md-flex__ellipsis"> + <span class="md-footer-nav__direction"> + Previous + </span> + Backups + </span> + </div> + </a> + + + <a href="../../System-Deployment/Docker/" title="Docker" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> + <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> + <span class="md-flex__ellipsis"> + <span class="md-footer-nav__direction"> + Next + </span> + Docker + </span> + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> + </div> + </a> + + </nav> + </div> + + <div class="md-footer-meta md-typeset"> + <div class="md-footer-meta__inner md-grid"> + <div class="md-footer-copyright"> + + powered by + <a href="http://www.mkdocs.org" title="MkDocs">MkDocs</a> + and + <a href="http://squidfunk.github.io/mkdocs-material/" title="Material for MkDocs"> + Material for MkDocs</a> + </div> + + + <div class="md-footer-social"> + + <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"> + + <a href="https://github.com/ponzu-cms" class="md-footer-social__link fa fa-github"></a> + + <a href="https://twitter.com/ponzu_cms" class="md-footer-social__link fa fa-twitter"></a> + + </div> + + + </div> + </div> +</footer> + + </div> + + <script src="../../assets/javascripts/application-6b599127bc.js"></script> + <script>app.initialize({url:{base:"../.."}})</script> + + + + + <script>!function(e,t,a,n,o,c,i){e.GoogleAnalyticsObject=o,e[o]=e[o]||function(){(e[o].q=e[o].q||[]).push(arguments)},e[o].l=1*new Date,c=t.createElement(a),i=t.getElementsByTagName(a)[0],c.async=1,c.src=n,i.parentNode.insertBefore(c,i)}(window,document,"script","https://www.google-analytics.com/analytics.js","ga"),ga("create","UA-98609560-1","auto"),ga("set","anonymizeIp",!0),ga("send","pageview");var links=document.getElementsByTagName("a");Array.prototype.map.call(links,function(e){e.host!=document.location.host&&e.addEventListener("click",function(){var t=e.getAttribute("data-md-action")||"follow";ga("send","event","outbound",t,e.href)})});var query=document.forms.search.query;query.addEventListener("blur",function(){if(this.value){var e=document.location.pathname;ga("send","pageview",e+"?q="+this.value)}})</script> + + + </body> +</html>
\ No newline at end of file |