Skip to content

Commit 3f1c30f

Browse files
committed
Update runbook
Add a README.md for samples
1 parent a187022 commit 3f1c30f

File tree

5 files changed

+231
-5
lines changed

5 files changed

+231
-5
lines changed

docs/index.html

Lines changed: 80 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -404,6 +404,84 @@ <h1>Settings<a class="headerlink" href="#settings" title="Permalink to this head
404404
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">EnvConfig</span>
405405
</pre></div>
406406
</div>
407+
<dl class="py attribute">
408+
<dt class="sig sig-object py">
409+
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">**host**</span></span></dt>
410+
<dd><p>The host address for the server.</p>
411+
</dd></dl>
412+
413+
<dl class="py attribute">
414+
<dt class="sig sig-object py">
415+
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">**port**</span></span></dt>
416+
<dd><p>The port number for the server.</p>
417+
</dd></dl>
418+
419+
<dl class="py attribute">
420+
<dt class="sig sig-object py">
421+
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">**workers**</span></span></dt>
422+
<dd><p>The number of worker processes for handling requests.</p>
423+
</dd></dl>
424+
425+
<dl class="py attribute">
426+
<dt class="sig sig-object py">
427+
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">**debug**</span></span></dt>
428+
<dd><p>Enable or disable debug mode.</p>
429+
</dd></dl>
430+
431+
<dl class="py attribute">
432+
<dt class="sig sig-object py">
433+
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">**origins**</span></span></dt>
434+
<dd><p>A list of allowed origins for CORS.</p>
435+
</dd></dl>
436+
437+
<dl class="py attribute">
438+
<dt class="sig sig-object py">
439+
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">**database**</span></span></dt>
440+
<dd><p>The path to the database file.</p>
441+
</dd></dl>
442+
443+
<dl class="py attribute">
444+
<dt class="sig sig-object py">
445+
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">**allow_public_ip**</span></span></dt>
446+
<dd><p>Allow access from public IP address.</p>
447+
</dd></dl>
448+
449+
<dl class="py attribute">
450+
<dt class="sig sig-object py">
451+
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">**allow_private_ip**</span></span></dt>
452+
<dd><p>Allow access from private IP address.</p>
453+
</dd></dl>
454+
455+
<dl class="py attribute">
456+
<dt class="sig sig-object py">
457+
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">**origin_refresh**</span></span></dt>
458+
<dd><p>Time interval to refresh allowed origins.</p>
459+
</dd></dl>
460+
461+
<dl class="py attribute">
462+
<dt class="sig sig-object py">
463+
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">**rate_limit**</span></span></dt>
464+
<dd><p>Rate limiting settings for incoming requests.</p>
465+
</dd></dl>
466+
467+
<dl class="py attribute">
468+
<dt class="sig sig-object py">
469+
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">**unsupported_browsers**</span></span></dt>
470+
<dd><p>List of unsupported browsers.</p>
471+
</dd></dl>
472+
473+
<dl class="py attribute">
474+
<dt class="sig sig-object py">
475+
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">**warn_page**</span></span></dt>
476+
<dd><p>Path to the custom warning page HTML file.</p>
477+
</dd></dl>
478+
479+
<dl class="py attribute">
480+
<dt class="sig sig-object py">
481+
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">**error_page**</span></span></dt>
482+
<dd><p>Path to the custom error page HTML file.</p>
483+
</dd></dl>
484+
407485
<p>Create a new model by parsing and validating input data from keyword arguments.</p>
408486
<p>Raises [<cite>ValidationError</cite>][pydantic_core.ValidationError] if the input data cannot be
409487
validated to form a valid model.</p>
@@ -866,8 +944,8 @@ <h1>Configuration<a class="headerlink" href="#configuration" title="Permalink to
866944
<li><p><strong>disableUsedPercentage</strong> - Disables the used volume percentage.</p></li>
867945
<li><dl class="simple">
868946
<dt><strong>files</strong> - The path to the branding files.</dt><dd><ul>
869-
<li><p>custom.css, containing the styles you want to apply to your installation.</p></li>
870-
<li><p>img a directory whose files can replace the default logotypes in the application</p></li>
947+
<li><p>custom.css: Containing the styles you want to apply to your installation.</p></li>
948+
<li><p>img: A directory whose files can replace the default logotypes in the application.</p></li>
871949
</ul>
872950
</dd>
873951
</dl>

0 commit comments

Comments
 (0)