docfix

Author: bryans99

docs/index.html

@@ -203,7 +203,7 @@ <h3>Step 1 - Enable Embedding in your Looker instance</h3>
   <h3>Step 2 - Customize the Demo settings for your Looker instance</h3>
 </a>
 <p>The embed demo environment can be configured using a <code>.env</code> file. The following is a template that can be used to create the file (in the root of this repo). The <code>.env</code> file should never be stored in your git repo and is included in the repo&#39;s <code>.gitignore</code> file.</p>
-<pre><code class="language-shell"><span class="hl-6"># Demo Server Configuration</span><br/><br/><span class="hl-6"># Protocol for the demo server to listen</span><br/><span class="hl-6"># http or https. Use https if Reports are to be embedded</span><br/><span class="hl-1">LOOKER_DEMO_PROTOCOL=http</span><br/><span class="hl-6"># Allow server to be called using a URL other than localhost or 127,0.0.1</span><br/><span class="hl-6"># Set to true when developing Embedded Reports</span><br/><span class="hl-1">LOOKER_DEMO_HOST_EXTERNAL=false</span><br/><span class="hl-6"># Looker Web Server (omit the protocol)</span><br/><span class="hl-6"># LOOKER_EMBED_HOST can also be used</span><br/><span class="hl-1">LOOKER_WEB_URL=mycompany.looker.com</span><br/><span class="hl-6"># Looker API server (include the protocol)</span><br/><span class="hl-6"># LOOKER_EMBED_API_URL can also be used</span><br/><span class="hl-1">LOOKER_API_URL=https://&lt;instance_name&gt;.cloud.looker.com</span><br/><span class="hl-6"># Host name for the demo server</span><br/><span class="hl-1">LOOKER_DEMO_HOST=localhost</span><br/><span class="hl-6"># Port for the demo server</span><br/><span class="hl-1">LOOKER_DEMO_PORT=8080</span><br/><span class="hl-6"># Demo server cookie secret (used to encrypt the cookie)</span><br/><span class="hl-1">COOKIE_SECRET=cookie_stash</span><br/><span class="hl-6"># Verify the Looker certificate (for most embed developers, the Looker certificate will be valid)</span><br/><span class="hl-1">LOOKER_VERIFY_SSL=true</span><br/><br/><span class="hl-6"># Looker Embed Configuration</span><br/><br/><span class="hl-6"># Embed type to demo</span><br/><span class="hl-6"># signed - use signed embedding</span><br/><span class="hl-6"># cookieless - use cookieless embedding</span><br/><span class="hl-6"># private - use private embedding</span><br/><span class="hl-1">LOOKER_EMBED_TYPE=signed</span><br/><span class="hl-6"># Looker embed secret - from /admin/embed page</span><br/><span class="hl-1">LOOKER_EMBED_SECRET=</span><br/><span class="hl-6"># Looker client id - from /admin/users/api3_key/{id}</span><br/><span class="hl-1">LOOKER_CLIENT_ID=</span><br/><span class="hl-6"># Looker client secret - from /admin/users/api3_key/{id}</span><br/><span class="hl-1">LOOKER_CLIENT_SECRET=</span><br/><span class="hl-6"># Use dynamic embed domains for cookieless embed</span><br/><span class="hl-1">LOOKER_USE_EMBED_DOMAIN=false</span><br/><br/><span class="hl-6"># Looker Embed Data Configuration</span><br/><span class="hl-6"># Set to &quot;-&quot; if demo needs to ignore it</span><br/><br/><span class="hl-6"># Dashboard IDs</span><br/><span class="hl-1">LOOKER_DASHBOARD_ID=1</span><br/><span class="hl-1">LOOKER_DASHBOARD_ID_2=2</span><br/><span class="hl-6"># Look ID</span><br/><span class="hl-1">LOOKER_LOOK_ID=1</span><br/><span class="hl-6"># Explore ID</span><br/><span class="hl-1">LOOKER_EXPLORE_ID=thelook::orders</span><br/><span class="hl-6"># Extension ID</span><br/><span class="hl-1">LOOKER_EXTENSION_ID=extension::my-great-extension</span><br/><span class="hl-6"># Report ID</span><br/><span class="hl-1">LOOKER_REPORT_ID=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee</span><br/><span class="hl-6"># Query Visualization ID</span><br/><span class="hl-1">LOOKER_QUERY_VISUALIZATION_ID=1234567890ABCDEF123456</span><br/><br/><span class="hl-6"># Theme configuration, Dashboards, Looks and Explores</span><br/><span class="hl-1">LOOKER_THEME=Dark</span><br/><span class="hl-1">LOOKER_CUSTOM_THEME={</span><span class="hl-2">&quot;show_title&quot;</span><span class="hl-1">:false,</span><span class="hl-2">&quot;show_filters_bar&quot;</span><span class="hl-1">:false,</span><span class="hl-2">&quot;text_tile_text_color&quot;</span><span class="hl-1">:</span><span class="hl-2">&quot;blue&quot;</span><span class="hl-1">}</span>
+<pre><code class="language-shell"><span class="hl-6"># Demo Server Configuration</span><br/><br/><span class="hl-6"># Protocol for the demo server to listen</span><br/><span class="hl-6"># http or https. Use https if Reports are to be embedded</span><br/><span class="hl-1">LOOKER_DEMO_PROTOCOL=http</span><br/><span class="hl-6"># Allow server to be called using a URL other than localhost or 127,0.0.1</span><br/><span class="hl-6"># Set to true when developing Embedded Reports</span><br/><span class="hl-1">LOOKER_DEMO_HOST_EXTERNAL=false</span><br/><span class="hl-6"># Looker Web Server (omit the protocol)</span><br/><span class="hl-6"># LOOKER_EMBED_HOST can also be used</span><br/><span class="hl-1">LOOKER_WEB_URL=mycompany.looker.com</span><br/><span class="hl-6"># Looker API server (include the protocol)</span><br/><span class="hl-6"># LOOKER_EMBED_API_URL can also be used</span><br/><span class="hl-1">LOOKER_API_URL=https://mycompany.looker.com</span><br/><span class="hl-6"># Host name for the demo server</span><br/><span class="hl-1">LOOKER_DEMO_HOST=localhost</span><br/><span class="hl-6"># Port for the demo server</span><br/><span class="hl-1">LOOKER_DEMO_PORT=8080</span><br/><span class="hl-6"># Demo server cookie secret (used to encrypt the cookie)</span><br/><span class="hl-1">COOKIE_SECRET=cookie_stash</span><br/><span class="hl-6"># Verify the Looker certificate (for most embed developers, the Looker certificate will be valid)</span><br/><span class="hl-1">LOOKER_VERIFY_SSL=true</span><br/><br/><span class="hl-6"># Looker Embed Configuration</span><br/><br/><span class="hl-6"># Embed type to demo</span><br/><span class="hl-6"># signed - use signed embedding</span><br/><span class="hl-6"># cookieless - use cookieless embedding</span><br/><span class="hl-6"># private - use private embedding</span><br/><span class="hl-1">LOOKER_EMBED_TYPE=signed</span><br/><span class="hl-6"># Looker embed secret - from /admin/embed page</span><br/><span class="hl-1">LOOKER_EMBED_SECRET=</span><br/><span class="hl-6"># Looker client id - from /admin/users/api3_key/{id}</span><br/><span class="hl-1">LOOKER_CLIENT_ID=</span><br/><span class="hl-6"># Looker client secret - from /admin/users/api3_key/{id}</span><br/><span class="hl-1">LOOKER_CLIENT_SECRET=</span><br/><span class="hl-6"># Use dynamic embed domains for cookieless embed</span><br/><span class="hl-1">LOOKER_USE_EMBED_DOMAIN=false</span><br/><br/><span class="hl-6"># Looker Embed Data Configuration</span><br/><span class="hl-6"># Set to &quot;-&quot; if demo needs to ignore it</span><br/><br/><span class="hl-6"># Dashboard IDs</span><br/><span class="hl-1">LOOKER_DASHBOARD_ID=1</span><br/><span class="hl-1">LOOKER_DASHBOARD_ID_2=2</span><br/><span class="hl-6"># Look ID</span><br/><span class="hl-1">LOOKER_LOOK_ID=1</span><br/><span class="hl-6"># Explore ID</span><br/><span class="hl-1">LOOKER_EXPLORE_ID=thelook::orders</span><br/><span class="hl-6"># Extension ID</span><br/><span class="hl-1">LOOKER_EXTENSION_ID=extension::my-great-extension</span><br/><span class="hl-6"># Report ID</span><br/><span class="hl-1">LOOKER_REPORT_ID=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee</span><br/><span class="hl-6"># Query Visualization ID</span><br/><span class="hl-1">LOOKER_QUERY_VISUALIZATION_ID=1234567890ABCDEF123456</span><br/><br/><span class="hl-6"># Theme configuration, Dashboards, Looks and Explores</span><br/><span class="hl-1">LOOKER_THEME=Dark</span><br/><span class="hl-1">LOOKER_CUSTOM_THEME={</span><span class="hl-2">&quot;show_title&quot;</span><span class="hl-1">:false,</span><span class="hl-2">&quot;show_filters_bar&quot;</span><span class="hl-1">:false,</span><span class="hl-2">&quot;text_tile_text_color&quot;</span><span class="hl-1">:</span><span class="hl-2">&quot;blue&quot;</span><span class="hl-1">}</span>
 </code></pre>
 <ul>
 <li>Edit the <code>demo/demo_user.json</code> file to be appropriate for the type of user you want to embed. Normally your backend service would use information about the user logged into your embedding application to inform Looker about important user properties that control data access controls. The <code>demo/demo_user.json</code> file is also used for cookieless embedding. Remember that cookieless_embed always treats <code>force_logout_login</code> as <code>true</code>. See <a href="https://cloud.google.com/looker/docs/single-sign-on-embedding">documentation</a> for detailed information on the content of the embed user definition.</li>