github/endurain
1
1
Fork 0
mirror of https://github.com/joaovitoriasilva/endurain.git synced 2026-01-07 23:13:57 -05:00
Code Issues 45 Packages Projects Releases Wiki Activity

Deployed 9cffa434 with MkDocs version: 1.6.1

Browse Source
This commit is contained in:
João Vitória Silva
2025-12-23 12:09:59 +00:00
parent 53c9b76594
commit 90aafe7d5f
16 changed files with 1152 additions and 232 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
404.html
View File

@@ -376,7 +376,7 @@
<span class="md-ellipsis">
Bare-Metal Installation Guide
Bare-Metal installation guide
</span>

1248
developer-guide/authentication/index.html
View File

File diff suppressed because it is too large Load Diff

2
developer-guide/setup-dev-env/index.html
View File

@@ -385,7 +385,7 @@
<span class="md-ellipsis">
Bare-Metal Installation Guide
Bare-Metal installation guide
</span>

2
developer-guide/supported-types/index.html
View File

@@ -385,7 +385,7 @@
<span class="md-ellipsis">
Bare-Metal Installation Guide
Bare-Metal installation guide
</span>

2
features/single-sign-on/index.html
View File

@@ -385,7 +385,7 @@
<span class="md-ellipsis">
Bare-Metal Installation Guide
Bare-Metal installation guide
</span>

2
features/sleep-scoring/index.html
View File

@@ -385,7 +385,7 @@
<span class="md-ellipsis">
Bare-Metal Installation Guide
Bare-Metal installation guide
</span>

2
gallery/index.html
View File

@@ -383,7 +383,7 @@
<span class="md-ellipsis">
Bare-Metal Installation Guide
Bare-Metal installation guide
</span>

55
getting-started/advanced-started/index.html
View File

@@ -429,6 +429,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#session-timeout-configuration-optional" class="md-nav__link">
<span class="md-ellipsis">
Session Timeout Configuration (Optional)
</span>
</a>
</li>
<li class="md-nav__item">
@@ -569,7 +578,7 @@
<span class="md-ellipsis">
Bare-Metal Installation Guide
Bare-Metal installation guide
</span>
@@ -1000,6 +1009,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#session-timeout-configuration-optional" class="md-nav__link">
<span class="md-ellipsis">
Session Timeout Configuration (Optional)
</span>
</a>
</li>
<li class="md-nav__item">
@@ -1315,6 +1333,24 @@
<td>Time in days</td>
</tr>
<tr>
<td>SESSION_IDLE_TIMEOUT_ENABLED</td>
<td>false</td>
<td>Yes</td>
<td>Enforce idle timeouts (supported values are <code>true</code> and <code>false</code>)</td>
</tr>
<tr>
<td>SESSION_IDLE_TIMEOUT_HOURS</td>
<td>1</td>
<td>Yes</td>
<td>Time in hours</td>
</tr>
<tr>
<td>SESSION_ABSOLUTE_TIMEOUT_HOURS</td>
<td>24</td>
<td>Yes</td>
<td>Time in hours</td>
</tr>
<tr>
<td>JAEGER_ENABLED</td>
<td>false</td>
<td>Yes</td>
@@ -1348,7 +1384,7 @@
<td>ENVIRONMENT</td>
<td>production</td>
<td>Yes</td>
<td>"production" and "development" allowed. "development" allows connections from localhost:8080 and localhost:5173 at the CORS level</td>
<td><code>production</code>, <code>demo</code> and <code>development</code> allowed. <code>development</code> allows connections from localhost:8080 and localhost:5173 at the CORS level. <code>demo</code> equals to <code>production</code> except it does not return user sessions</td>
</tr>
<tr>
<td>SMTP_HOST</td>
@@ -1431,6 +1467,21 @@
<li>To check npm dependencies used, use npm file (package.json)</li>
<li>Logo created on Canva</li>
</ul>
<h2 id="session-timeout-configuration-optional">Session Timeout Configuration (Optional)</h2>
<p>By default, Endurain sessions last 7 days without enforcing idle timeouts.
For enhanced security, you can enable automatic session expiration:</p>
<p><strong>Environment Variables:</strong></p>
<ul>
<li><code>SESSION_IDLE_TIMEOUT_ENABLED</code>: Enable timeout enforcement (default: <code>false</code>)</li>
<li><code>SESSION_IDLE_TIMEOUT_HOURS</code>: Logout after inactivity (default: <code>1</code>)</li>
<li><code>SESSION_ABSOLUTE_TIMEOUT_HOURS</code>: Force re-login after duration (default: <code>24</code>)</li>
</ul>
<p><strong>Example:</strong></p>
<div class="highlight"><pre><span></span><code><span class="nt">environment</span><span class="p">:</span>
<span class="w"> </span><span class="nt">SESSION_IDLE_TIMEOUT_ENABLED</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;true&quot;</span>
<span class="w"> </span><span class="nt">SESSION_IDLE_TIMEOUT_HOURS</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2&quot;</span>
<span class="w"> </span><span class="nt">SESSION_ABSOLUTE_TIMEOUT_HOURS</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;48&quot;</span>
</code></pre></div>
<h2 id="docker-secrets-support">Docker Secrets Support</h2>
<p>Endurain supports <a href="https://docs.docker.com/compose/how-tos/use-secrets/">Docker secrets</a> for securely managing sensitive environment variables. For the following environment variables, you can use <code>_FILE</code> variants that read the secret from a file instead of storing it directly in environment variables:</p>
<ul>

57
getting-started/bare-metal/index.html
View File

@@ -20,7 +20,7 @@
<title>Bare-Metal Installation Guide - Endurain documentation</title>
<title>Bare-Metal installation guide - Endurain documentation</title>
@@ -128,7 +128,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Bare-Metal Installation Guide
Bare-Metal installation guide
</span>
</div>
@@ -396,7 +396,7 @@
<span class="md-ellipsis">
Bare-Metal Installation Guide
Bare-Metal installation guide
</span>
@@ -409,7 +409,7 @@
<span class="md-ellipsis">
Bare-Metal Installation Guide
Bare-Metal installation guide
</span>
@@ -501,6 +501,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#9-update-to-a-new-version-of-endurain" class="md-nav__link">
<span class="md-ellipsis">
9. Update to a new version of Endurain.
</span>
</a>
</li>
</ul>
@@ -979,6 +988,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#9-update-to-a-new-version-of-endurain" class="md-nav__link">
<span class="md-ellipsis">
9. Update to a new version of Endurain.
</span>
</a>
</li>
</ul>
@@ -1118,6 +1136,37 @@ sudo<span class="w"> </span>-u<span class="w"> </span>postgres<span class="w"> <
systemctl<span class="w"> </span><span class="nb">enable</span><span class="w"> </span>endurain
systemctl<span class="w"> </span>start<span class="w"> </span>endurain
</code></pre></div>
<h2 id="9-update-to-a-new-version-of-endurain">9. Update to a new version of Endurain.</h2>
<p>Remove old version and get the latest.</p>
<div class="highlight"><pre><span></span><code>systemctl<span class="w"> </span>stop<span class="w"> </span>endurain
rm<span class="w"> </span>-rf<span class="w"> </span>/path/to/endurain/*
<span class="nb">cd</span><span class="w"> </span>/path/to/endurain
<span class="nv">TAG</span><span class="o">=</span><span class="k">$(</span>curl<span class="w"> </span>-s<span class="w"> </span>https://api.github.com/repos/endurain-project/endurain/releases/latest<span class="w"> </span><span class="se">\</span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span>grep<span class="w"> </span>-oP<span class="w"> </span><span class="s1">&#39;&quot;tag_name&quot;: &quot;\K(.*)(?=&quot;)&#39;</span><span class="k">)</span>
curl<span class="w"> </span>-L<span class="w"> </span><span class="s2">&quot;https://github.com/endurain-project/endurain/archive/refs/tags/</span><span class="nv">$TAG</span><span class="s2">.tar.gz&quot;</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span>tar<span class="w"> </span>xz
<span class="nv">EXTRACTED</span><span class="o">=</span><span class="k">$(</span>ls<span class="w"> </span>-d<span class="w"> </span>endurain-*<span class="k">)</span>
<span class="nb">shopt</span><span class="w"> </span>-s<span class="w"> </span>dotglob
mv<span class="w"> </span><span class="s2">&quot;</span><span class="nv">$EXTRACTED</span><span class="s2">&quot;</span>/*<span class="w"> </span>.
<span class="nb">shopt</span><span class="w"> </span>-u<span class="w"> </span>dotglob
rm<span class="w"> </span>-rf<span class="w"> </span><span class="s2">&quot;</span><span class="nv">$EXTRACTED</span><span class="s2">&quot;</span>
</code></pre></div>
<p>Build the Frontend.</p>
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>/path/to/endurain/frontend/app
npm<span class="w"> </span>ci
npm<span class="w"> </span>run<span class="w"> </span>build
</code></pre></div>
<p>Set Up the Backend.</p>
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>/path/to/endurain/backend
poetry<span class="w"> </span><span class="nb">export</span><span class="w"> </span>-f<span class="w"> </span>requirements.txt<span class="w"> </span>--output<span class="w"> </span>requirements.txt<span class="w"> </span>--without-hashes
uv<span class="w"> </span>venv
uv<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements.txt
</code></pre></div>
<p>start the service.</p>
<div class="highlight"><pre><span></span><code>systemctl<span class="w"> </span>start<span class="w"> </span>endurain
</code></pre></div>

2
getting-started/getting-started/index.html
View File

@@ -585,7 +585,7 @@
<span class="md-ellipsis">
Bare-Metal Installation Guide
Bare-Metal installation guide
</span>

2
getting-started/maria-to-postgres-migration/index.html
View File

@@ -387,7 +387,7 @@
<span class="md-ellipsis">
Bare-Metal Installation Guide
Bare-Metal installation guide
</span>

2
index.html
View File

@@ -520,7 +520,7 @@
<span class="md-ellipsis">
Bare-Metal Installation Guide
Bare-Metal installation guide
</span>

2
integrations/3rd-party-apps/index.html
View File

@@ -385,7 +385,7 @@
<span class="md-ellipsis">
Bare-Metal Installation Guide
Bare-Metal installation guide
</span>

2
integrations/3rd-party-services/index.html
View File

@@ -385,7 +385,7 @@
<span class="md-ellipsis">
Bare-Metal Installation Guide
Bare-Metal installation guide
</span>

2
search/search_index.json
View File

File diff suppressed because one or more lines are too long

BIN
sitemap.xml.gz
View File

Binary file not shown.