Update documentation to commit 8224eee

commit 8224eee
Merge: efc15ea 4fd97ce
Author:     mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
AuthorDate: Thu Jul 6 15:19:39 2023 +0000
Commit:     GitHub <[email protected]>
CommitDate: Thu Jul 6 15:19:39 2023 +0000

    Merge pull request os-autoinst#5232 from asdil12/nginx

    Extend install doc to cover nginx and improve nginx config

docs/api/testapi.html

@@ -2062,7 +2062,7 @@ <h5 id="_backend_get_wait_still_screen_on_here_doc_input">backend_get_wait_still
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2023-06-28 02:28:13 UTC
+Last updated 2023-07-07 02:26:36 UTC
 </div>
 </div>
 </body>

docs/index.html

@@ -574,6 +574,7 @@ <h1>openQA Documentation</h1>
 <li><a href="#basic-configuration">Basic configuration</a>
 <ul class="sectlevel2">
 <li><a href="#_apache_proxy">Apache proxy</a></li>
+<li><a href="#_nginx_proxy">NGINX proxy</a></li>
 <li><a href="#_tlsssl">TLS/SSL</a></li>
 <li><a href="#database">Database</a>
 <ul class="sectlevel3">
@@ -2194,15 +2195,19 @@ <h2 id="basic-configuration">Basic configuration</h2>
 </div>
 </div>
 <div class="paragraph">
-<p>This will automatically setup a local apache http proxy. Read on for more
+<p>This will automatically setup a local Apache http proxy. Read on for more
 detailed setup instructions with all the details.</p>
 </div>
+<div class="paragraph">
+<p>If you wish to run openQA behind an http proxy (Apache, NGINX, …) then see the
+<strong>openqa.conf.template</strong> config file in <strong>/etc/apache2/vhosts.d</strong> (openSUSE) or
+<code>/etc/httpd/conf.d</code> (Fedora) when using apache2 or the config files in
+<code>/etc/nginx/vhosts.d</code> for NGINX.</p>
+</div>
 <div class="sect2">
 <h3 id="_apache_proxy">Apache proxy</h3>
 <div class="paragraph">
-<p>It is required to run openQA behind an http proxy (apache, nginx, etc..). See the
-<strong>openqa.conf.template</strong> config file in <strong>/etc/apache2/vhosts.d</strong> (openSUSE) or
-<code>/etc/httpd/conf.d</code> (Fedora). To make everything work correctly on openSUSE, you
+<p>To make everything work correctly on openSUSE when using Apache, you
 need to enable the 'headers', 'proxy', 'proxy_http', 'proxy_wstunnel' and 'rewrite'
 modules using the command 'a2enmod'. This is not necessary on Fedora.</p>
 </div>
@@ -2218,8 +2223,9 @@ <h3 id="_apache_proxy">Apache proxy</h3>
 </div>
 </div>
 <div class="paragraph">
-<p>For a basic setup, you can copy <strong>openqa.conf.template</strong> to <strong>openqa.conf</strong> and modify the <code>ServerName</code> setting if
-required. This will direct all HTTP traffic to openQA.</p>
+<p>For a basic setup, you can copy <strong>openqa.conf.template</strong> to <strong>openqa.conf</strong>
+and modify the <code>ServerName</code> setting if required.
+This will direct all HTTP traffic to openQA.</p>
 </div>
 <div class="listingblock">
 <div class="content">
@@ -2228,6 +2234,30 @@ <h3 id="_apache_proxy">Apache proxy</h3>
 </div>
 </div>
 <div class="sect2">
+<h3 id="_nginx_proxy">NGINX proxy</h3>
+<div class="paragraph">
+<p>For a basic setup, you can copy <strong>openqa.conf.template</strong> to <strong>openqa.conf</strong>
+and modify the <code>server_name</code> setting if required.
+This will direct all HTTP traffic to openQA.</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="pygments highlight"><code data-lang="sh"><span></span>cp<span class="tok-w"> </span>/etc/nginx/vhosts.d/openqa.conf.template<span class="tok-w"> </span>/etc/nginx/vhosts.d/openqa.conf</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Note that the default config in <strong>openqa.conf.template</strong> is using the keyword
+<code>default_server</code> in the <code>listen</code> statement. This will only change the behaviour
+when accessing the server via its IP address. This means that the default vhost
+for <code>localhost</code> in <strong>nginx.conf</strong> will take precedence when accessing the server
+via <code>localhost</code>. You might want to disable it.</p>
+</div>
+<div class="paragraph">
+<p>For openQA you need to set <code>httpsonly = 0</code> as described in the TLS/SSL section
+below, if you do not setup NGINX for SSL.</p>
+</div>
+</div>
+<div class="sect2">
 <h3 id="_tlsssl">TLS/SSL</h3>
 <div class="paragraph">
 <p>By default openQA expects to be run with HTTPS. The <code>openqa-ssl.conf.template</code>
@@ -12408,7 +12438,7 @@ <h3 id="_developing_tests_with_container_setup">Developing tests with container
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2023-06-28 02:25:28 UTC
+Last updated 2023-07-07 02:23:48 UTC
 </div>
 </div>
 </body>