Files
ThothII/install/first-start/index.html
T

175 lines
7.7 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="canonical" href="https://git.tylconsulting.it/thothii-docs/install/first-start/">
<link rel="shortcut icon" href="../../img/favicon.ico">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" />
<title>Start here - ThothII Docs</title>
<link href="../../css/bootstrap-3.3.7.min.css" rel="stylesheet">
<link href="../../css/font-awesome-4.7.0.css" rel="stylesheet">
<link href="../../css/base.css" rel="stylesheet">
<link rel="stylesheet" href="../../css/highlight.css">
<link href="../../stylesheets/extra.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
<script src="../../js/jquery-3.2.1.min.js"></script>
<script src="../../js/bootstrap-3.3.7.min.js"></script>
<script src="../../js/highlight.pack.js"></script>
<base target="_top">
<script>
var base_url = '../..';
var is_top_frame = false;
var pageToc = [
{title: "Install and first start", url: "#_top", children: [
{title: "What must be ready", url: "#what-must-be-ready" },
{title: "Follow the ordered procedure", url: "#follow-the-ordered-procedure" },
{title: "After startup", url: "#after-startup" },
]},
];
</script>
<script src="../../js/base.js"></script>
<script src="../../javascripts/layout-init.js"></script>
</head>
<body>
<script>
if (is_top_frame) { $('body').addClass('wm-top-page'); }
</script>
<div class="container-fluid wm-page-content">
<a name="_top"></a>
<div class="row wm-article-nav-buttons" role="navigation" aria-label="navigation">
<div class="wm-article-nav pull-right">
<a href="../standalone-manual-it/" class="btn btn-xs btn-default pull-right">
Next
<i class="fa fa-chevron-right" aria-hidden="true"></i>
</a>
<a href="../standalone-manual-it/" class="btn btn-xs btn-link">
Mac, Windows, Linux — Italiano
</a>
</div>
<div class="wm-article-nav">
<a href="../../guida-utente/" class="btn btn-xs btn-default pull-left">
<i class="fa fa-chevron-left" aria-hidden="true"></i>
Previous</a><a href="../../guida-utente/" class="btn btn-xs btn-link">
User guide
</a>
</div>
</div>
<h1 id="install-and-first-start">Install and first start<a class="headerlink" href="#install-and-first-start" title="Permanent link">&para;</a></h1>
<p>Use one complete procedure for a fresh installation:</p>
<ul>
<li><a href="../standalone-manual-it/">Italian manual installation</a></li>
<li><a href="../standalone-manual-en/">English manual installation</a></li>
</ul>
<p>Both cover macOS, Windows through Ubuntu WSL2, and Linux. They use a Gitea clone,
protected local configuration and manual terminal commands, without an application
installer or launcher. See their verification matrix for tests still pending.</p>
<h2 id="what-must-be-ready">What must be ready<a class="headerlink" href="#what-must-be-ready" title="Permanent link">&para;</a></h2>
<p>You need Docker with Compose, the host operator command <code>tht</code>, access to the workspace
repository, and the credentials and network routes for the configured DWH and model
providers. Pi runs inside the application runtime; no host Pi installation is needed.</p>
<p>The stack includes <code>frontend</code>, <code>core</code>, <code>catalog-db</code>, <code>qdrant</code>, <code>embedding</code>, plus the
one-shot <code>embedding-model-init</code> and <code>catalog-migrate</code> services. DWH and generative-model
endpoints remain separate installation settings.</p>
<p>Secrets, certificates, Pi authentication and endpoint bindings are protected local files.
Do not commit them or copy the configuration of another machine unchanged.</p>
<h2 id="follow-the-ordered-procedure">Follow the ordered procedure<a class="headerlink" href="#follow-the-ordered-procedure" title="Permanent link">&para;</a></h2>
<p>The bilingual guides provide the exact commands for:</p>
<ol>
<li>Cloning the selected revision and checking prerequisites.</li>
<li>Bootstrapping the native host command.</li>
<li>Preparing catalog passwords and using
<code>tht setup --profile local --shell-mode full --shell-default-locale en --configure-only</code>.</li>
<li>Completing model, authentication and workspace credentials.</li>
<li>Generating configuration, building images and explicitly running <code>catalog-migrate</code>.</li>
<li>Starting the installation and checking health and readiness.</li>
</ol>
<p>Do not run setup alone as a substitute for that sequence. Migrations are not an
implicit effect of backend startup or <code>tht start</code>. Do not mix this installation's
descriptor/project with a different low-level Compose environment.</p>
<p>For an already configured installation:</p>
<pre class="highlight"><code class="language-sh">tht --installation /absolute/path/thothii-installation.yaml status
tht --installation /absolute/path/thothii-installation.yaml doctor --json</code></pre>
<p><code>/health</code> checks application-process readiness. Doctor also checks configuration,
workspace, workflow and Pi prerequisites; a healthy web page alone does not prove
that a real database question can complete.</p>
<h2 id="after-startup">After startup<a class="headerlink" href="#after-startup" title="Permanent link">&para;</a></h2>
<p>Prepare <a href="../../operations/workspaces/">workspaces</a>, configure a database in
<a href="../../operations/database-management/">Database Management</a>, and complete the functional
checks in the installation guide before using real data.</p>
<p>See <a href="../shell-and-language/">display mode and language</a>, <a href="../authentication-local/">local authentication</a>,
<a href="../authentication-oidc/">OIDC</a> and <a href="../../general/pi-configuration/">model configuration</a>
for later changes. Embedded portal integration is separate from a fresh standalone setup.</p>
<p>Use the installation's normal <code>tht start</code>, <code>tht stop</code> and diagnostic commands.
Preserve its descriptor, credentials, database and persistent volumes; do not use
<code>down --volumes</code> as a routine stop or upgrade.</p>
<br>
<div class="row wm-article-nav-buttons" role="navigation" aria-label="navigation">
<div class="wm-article-nav pull-right">
<a href="../standalone-manual-it/" class="btn btn-xs btn-default pull-right">
Next
<i class="fa fa-chevron-right" aria-hidden="true"></i>
</a>
<a href="../standalone-manual-it/" class="btn btn-xs btn-link">
Mac, Windows, Linux — Italiano
</a>
</div>
<div class="wm-article-nav">
<a href="../../guida-utente/" class="btn btn-xs btn-default pull-left">
<i class="fa fa-chevron-left" aria-hidden="true"></i>
Previous</a><a href="../../guida-utente/" class="btn btn-xs btn-link">
User guide
</a>
</div>
</div>
<br>
</div>
<footer class="container-fluid wm-page-content">
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a> using <a href="https://github.com/gristlabs/mkdocs-windmill">Windmill</a> theme by Grist Labs.</p>
</footer>
</body>
</html>