π The open-source, offline-first Notion, Obsidian & Confluence alternative. Advanced Markdown, multi-tenant teams, OIDC/SSO, and local S3 backups. Deploy in one command.
Vue dockergolangkanbanknowledge-baseknowledge-managementmarkdownnote-takingnotesnotes-appnotionnuxtnuxtjsoffline-firstoidcpwaselfhostedssovuevuejswiki
feat: add reference pages (#401)
Smaug6e99d84f3885
diff --git a/frontend/app/App.vue b/frontend/app/App.vueindex 2b820421..534c926c 100644--- a/frontend/app/App.vue+++ b/frontend/app/App.vue@@ -2,7 +2,9 @@<div id="app"><ModalManager /><ContextMenuManager />- <NuxtPage />+ <NuxtLayout>+ <NuxtPage />+ </NuxtLayout><Notification /></div></template>diff --git a/frontend/app/pages/(public)/_components/AppFooter.vue b/frontend/app/components/AppFooter.vuesimilarity index 93%rename from frontend/app/pages/(public)/_components/AppFooter.vuerename to frontend/app/components/AppFooter.vueindex e07f9b80..db0497ff 100644--- a/frontend/app/pages/(public)/_components/AppFooter.vue+++ b/frontend/app/components/AppFooter.vue@@ -25,11 +25,9 @@/></svg></a>- <a href="https://twitter.com" target="_blank" aria-label="Twitter">+ <a href="mailto:[email protected]" target="_blank" aria-label="Email"><svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor">- <path- d="M18.244 2.25h3.308l-7.227 8.26 8.502 11.24H16.17l-5.214-6.817L4.99 21.75H1.68l7.73-8.835L1.254 2.25H8.08l4.713 6.231zm-1.161 17.52h1.833L7.084 4.126H5.117z"- />+ <path d="M12 12.713l-11.99-7.713v13.999h23.98v-13.999l-11.99 7.713zm0-2.427l10.99-7.086h-21.98l10.99 7.086z" /></svg></a></div>@@ -50,9 +48,9 @@<div class="links-column"><h4>Resources</h4><ul>- <li><a href="https://github.com/Smaug6739/Alexandrie/wiki" target="_blank">Documentation</a></li>+ <li><NuxtLink to="/reference/documentation" no-prefetch>Documentation</NuxtLink></li><li><a href="https://github.com/Smaug6739/Alexandrie/wiki" target="_blank">API Reference</a></li>- <li><a href="https://github.com/Smaug6739/Alexandrie/wiki/Syntax" target="_blank">Guides</a></li>+ <li><NuxtLink to="/about">About</NuxtLink></li></ul></div>@@ -69,7 +67,7 @@<div class="links-column"><h4>Legal</h4><ul>- <li><a href="#">Privacy Policy</a></li>+ <li><NuxtLink to="/reference/privacy">Privacy Policy</NuxtLink></li><li><a href="#">Terms of Service</a></li><li><a href="https://github.com/Smaug6739/Alexandrie/blob/main/LICENSE" target="_blank">MIT License</a></li></ul>diff --git a/frontend/app/pages/(public)/_components/AppHeader.vue b/frontend/app/components/AppHeader.vuesimilarity index 100%rename from frontend/app/pages/(public)/_components/AppHeader.vuerename to frontend/app/components/AppHeader.vuediff --git a/frontend/app/layouts/public.vue b/frontend/app/layouts/public.vuenew file mode 100644index 00000000..dc3637ea--- /dev/null+++ b/frontend/app/layouts/public.vue@@ -0,0 +1,19 @@+<template>+ <div class="container">+ <AppHeader />+ <slot />+ <AppFooter />+ </div>+</template>++<style scoped lang="scss">+.container {+ display: flex;+ width: 95%;+ padding: 1rem 0;+ margin: 0 auto;+ flex-direction: column;+ justify-content: space-between;+ padding-top: 1.5rem;+}+</style>diff --git a/frontend/app/pages/(public)/index.vue b/frontend/app/pages/(public)/index.vueindex 7919f3da..a4aa114a 100644--- a/frontend/app/pages/(public)/index.vue+++ b/frontend/app/pages/(public)/index.vue@@ -1,7 +1,5 @@<template><main>- <!-- Hero -->-<section ref="heroEl" class="hero"><div class="hero-bg"><span class="orb orb-1" />@@ -39,7 +37,6 @@</template><script setup lang="ts">-import AppFooter from './_components/AppFooter.vue';import BentoFeatures from './_components/BentoFeatures.vue';import FeaturesShowcase from './_components/FeaturesShowcase.vue';import OpenSourceStats from './_components/OpenSourceStats.vue';diff --git a/frontend/app/pages/(public)/login/index.vue b/frontend/app/pages/(public)/login/index.vueindex 2798281b..46634fbd 100644--- a/frontend/app/pages/(public)/login/index.vue+++ b/frontend/app/pages/(public)/login/index.vue@@ -1,52 +1,48 @@<template>- <div class="container">- <AppHeader />- <div class="body-container">- <IconApp style="width: 120px" />- <h1>Connection</h1>- <form @submit.prevent="login">- <div class="form-group">- <label for="username">Username</label>- <input id="username" v-model="username" type="username" :class="{ 'is-invalid': errors.username }" :disabled="loginDisabled" />- <p v-if="errors.username" class="invalid-feedback">{{ errors.username }}</p>+ <div class="body-container">+ <IconApp style="width: 120px" />+ <h1>Connection</h1>+ <form @submit.prevent="login">+ <div class="form-group">+ <label for="username">Username</label>+ <input id="username" v-model="username" type="username" :class="{ 'is-invalid': errors.username }" :disabled="loginDisabled" />+ <p v-if="errors.username" class="invalid-feedback">{{ errors.username }}</p>+ </div>+ <div class="form-group">+ <label for="password">Password</label>+ <div class="password-input">+ <input+ id="password"+ :key="`password-${showPassword}`"+ v-model="password"+ :type="showPassword ? 'text' : 'password'"+ :class="{ 'is-invalid': errors.password }"+ :disabled="loginDisabled"+ />+ <button type="button" class="password-toggle" @click="togglePassword">+ <div class="eye-icon" :class="{ show: showPassword }">+ <Icon v-if="showPassword" name="eye" />+ <Icon v-else name="eye_off" />+ </div>+ </button></div>- <div class="form-group">- <label for="password">Password</label>- <div class="password-input">- <input- id="password"- :key="`password-${showPassword}`"- v-model="password"- :type="showPassword ? 'text' : 'password'"- :class="{ 'is-invalid': errors.password }"- :disabled="loginDisabled"- />- <button type="button" class="password-toggle" @click="togglePassword">- <div class="eye-icon" :class="{ show: showPassword }">- <Icon v-if="showPassword" name="eye" />- <Icon v-else name="eye_off" />- </div>- </button>- </div>- <p v-if="errors.password" class="invalid-feedback">{{ errors.password }}</p>- </div>- <NuxtLink to="/signup" class="signup-link">Need an account? Sign up</NuxtLink>- <button class="btn" :disabled="loginDisabled" @click="login">Login</button>- <p v-if="loginDisabled" class="disabled">Native login is currently disabled. Please use one of the available authentication providers below.</p>- <OIDCProviders />-- <p v-if="errors.general" class="invalid-feedback general">{{ errors.general }}</p>- <p class="forgot-password-link">Forgot your password? <NuxtLink to="/login/request-reset">Click here</NuxtLink></p>- </form>- </div>- <AppFooter />+ <p v-if="errors.password" class="invalid-feedback">{{ errors.password }}</p>+ </div>+ <NuxtLink to="/signup" class="signup-link">Need an account? Sign up</NuxtLink>+ <button class="btn" :disabled="loginDisabled" @click="login">Login</button>+ <p v-if="loginDisabled" class="disabled">Native login is currently disabled. Please use one of the available authentication providers below.</p>+ <OIDCProviders />++ <p v-if="errors.general" class="invalid-feedback general">{{ errors.general }}</p>+ <p class="forgot-password-link">Forgot your password? <NuxtLink to="/login/request-reset">Click here</NuxtLink></p>+ </form></div></template><script setup lang="ts">-import AppHeader from '../_components/AppHeader.vue';-import AppFooter from '../_components/AppFooter.vue';-+definePageMeta({+ layout: 'public',+});const userStore = useUserStore();const router = useRouter();@@ -105,15 +101,6 @@ async function connect(username: string, password: string) {}</script><style scoped lang="scss">-.container {- display: flex;- width: 95%;- margin: 0 auto;- flex-direction: column;- justify-content: space-between;- padding-top: 1.5rem;-}-.body-container {display: flex;width: 100%;@@ -134,20 +121,10 @@ form {}.form-group {- display: flex;- width: 100%;- flex-direction: column;- gap: 6px;margin-bottom: 0.8rem;-- label {- font-size: 0.95rem;- font-weight: 600;- }}input {- width: 100%;padding: 0.6rem;&:disabled {background: var(--surface-transparent);@@ -230,7 +207,6 @@ input {font-weight: 600;color: var(--primary);transition: color $transition-fast ease;- text-decoration: none;&:hover {color: var(--primary-dark);diff --git a/frontend/app/pages/(public)/login/request-reset.vue b/frontend/app/pages/(public)/login/request-reset.vueindex ad055c1d..706f59fd 100644--- a/frontend/app/pages/(public)/login/request-reset.vue+++ b/frontend/app/pages/(public)/login/request-reset.vue@@ -1,27 +1,21 @@<template>- <div class="container">- <AppHeader />- <div class="body-container">- <IconApp style="width: 120px" />- <h1>Reset password</h1>- <form @submit.prevent="reset">- <div class="form-group">- <label for="username">Username</label>- <input id="username" v-model="username" type="username" :class="{ 'is-invalid': errors.username }" />- <p v-if="errors.username" class="invalid-feedback">{{ errors.username }}</p>- </div>- <button type="submit" class="btn">Request Reset</button>- <p v-if="errors.general" class="invalid-feedback">{{ errors.general }}</p>- <p class="issue">Having issue ? <NuxtLink to="mailto:[email protected]">Contact us !</NuxtLink></p>- </form>- </div>- <AppFooter />+ <div class="body-container">+ <IconApp style="width: 120px" />+ <h1>Reset password</h1>+ <form @submit.prevent="reset">+ <div class="form-group">+ <label for="username">Username</label>+ <input id="username" v-model="username" type="username" :class="{ 'is-invalid': errors.username }" />+ <p v-if="errors.username" class="invalid-feedback">{{ errors.username }}</p>+ </div>+ <button type="submit" class="btn">Request Reset</button>+ <p v-if="errors.general" class="invalid-feedback">{{ errors.general }}</p>+ <p class="issue">Having issue ? <NuxtLink to="mailto:[email protected]">Contact us !</NuxtLink></p>+ </form></div></template><script setup lang="ts">-import AppHeader from '../_components/AppHeader.vue';-import AppFooter from '../_components/AppFooter.vue';const username = ref('');const errors = ref({username: '',@@ -39,16 +33,6 @@ async function reset() {}</script><style scoped lang="scss">-.container {- display: flex;- width: 95%;- height: 100%;- margin: 0 auto;- flex-direction: column;- justify-content: space-between;- padding-top: 1.5rem;-}-.body-container {display: flex;width: 100%;@@ -63,7 +47,6 @@ h1 {font-size: 2.5em;}-/* ===== Formulaire ===== */form {width: 100%;}diff --git a/frontend/app/pages/(public)/login/reset.vue b/frontend/app/pages/(public)/login/reset.vueindex 93a10947..430eb683 100644--- a/frontend/app/pages/(public)/login/reset.vue+++ b/frontend/app/pages/(public)/login/reset.vue@@ -1,6 +1,5 @@<template><div class="container">- <AppHeader /><div class="body-container"><IconApp style="width: 120px" /><h1>Password Reset</h1>@@ -33,13 +32,10 @@<p class="sub"><NuxtLink to="/login">Return to login</NuxtLink></p></form></div>- <AppFooter /></div></template><script setup lang="ts">-import AppHeader from '../_components/AppHeader.vue';-import AppFooter from '../_components/AppFooter.vue';const password = ref('');const confirmPassword = ref('');const showPassword = ref(false);diff --git a/frontend/app/pages/(public)/signup.vue b/frontend/app/pages/(public)/signup.vueindex 9ccffda5..94254d1c 100644--- a/frontend/app/pages/(public)/signup.vue+++ b/frontend/app/pages/(public)/signup.vue@@ -1,75 +1,66 @@<template>- <div class="container">- <AppHeader />- <div class="body-container">- <IconApp style="width: 120px" />- <h1>Account creation</h1>- <form @submit.prevent="register">- <div class="form-group">- <label for="username">Username <span class="required">*</span></label>- <input id="username" v-model="username" type="text" :class="{ 'is-invalid': errors.username }" />- <p v-if="errors.username" class="invalid-feedback">{{ errors.username }}</p>+ <div class="body-container">+ <IconApp style="width: 120px" />+ <h1>Account creation</h1>+ <form @submit.prevent="register">+ <div class="form-group">+ <label for="username">Username <span class="required">*</span></label>+ <input id="username" v-model="username" type="text" :class="{ 'is-invalid': errors.username }" />+ <p v-if="errors.username" class="invalid-feedback">{{ errors.username }}</p>+ </div>+ <div class="form-group">+ <label for="email">Email </label>+ <input id="email" v-model="email" type="email" />+ <small>Email is only used for account recovery. It will not be shared publicly.</small>+ </div>+ <div class="form-group">+ <label for="password">Password <span class="required">*</span></label>+ <div class="password-input">+ <input+ id="password"+ :key="`password-${showPassword}`"+ v-model="password"+ :type="showPassword ? 'text' : 'password'"+ :class="{ 'is-invalid': errors.password }"+ />+ <button type="button" class="password-toggle" @click="togglePassword">+ <div class="eye-icon" :class="{ show: showPassword }">+ <Icon v-if="showPassword" name="eye" />+ <Icon v-else name="eye_off" />+ </div>+ </button></div>- <div class="form-group">- <label for="email">Email </label>- <input id="email" v-model="email" type="email" />- <small>Email is only used for account recovery. It will not be shared publicly.</small>+ <p v-if="errors.password" class="invalid-feedback">{{ errors.password }}</p>+ </div>+ <div class="form-group">+ <label for="confirmPassword">Confirm Password <span class="required">*</span></label>+ <div class="password-input">+ <input+ id="confirmPassword"+ :key="`confirmPassword-${showConfirmPassword}`"+ v-model="confirmPassword"+ :type="showConfirmPassword ? 'text' : 'password'"+ :class="{ 'is-invalid': errors.confirmPassword }"+ />+ <button type="button" class="password-toggle" @click="toggleConfirmPassword">+ <div class="eye-icon" :class="{ show: showConfirmPassword }">+ <Icon v-if="showConfirmPassword" name="eye" />+ <Icon v-else name="eye_off" />+ </div>+ </button></div>- <div class="form-group">- <label for="password">Password <span class="required">*</span></label>- <div class="password-input">- <input- id="password"- :key="`password-${showPassword}`"- v-model="password"- :type="showPassword ? 'text' : 'password'"- :class="{ 'is-invalid': errors.password }"- />- <button type="button" class="password-toggle" @click="togglePassword">- <div class="eye-icon" :class="{ show: showPassword }">- <Icon v-if="showPassword" name="eye" />- <Icon v-else name="eye_off" />- </div>- </button>- </div>- <p v-if="errors.password" class="invalid-feedback">{{ errors.password }}</p>- </div>- <div class="form-group">- <label for="confirmPassword">Confirm Password <span class="required">*</span></label>- <div class="password-input">- <input- id="confirmPassword"- :key="`confirmPassword-${showConfirmPassword}`"- v-model="confirmPassword"- :type="showConfirmPassword ? 'text' : 'password'"- :class="{ 'is-invalid': errors.confirmPassword }"- />- <button type="button" class="password-toggle" @click="toggleConfirmPassword">- <div class="eye-icon" :class="{ show: showConfirmPassword }">- <Icon v-if="showConfirmPassword" name="eye" />- <Icon v-else name="eye_off" />- </div>- </button>- </div>- <p v-if="errors.confirmPassword" class="invalid-feedback">{{ errors.confirmPassword }}</p>- </div>- <NuxtLink to="/login" class="login-link">Already have an account? Log in</NuxtLink>- <button type="submit" class="btn">Sign Up</button>- <p v-if="errors.general" class="invalid-feedback">{{ errors.general }}</p>- </form>- </div>- <AppFooter />+ <p v-if="errors.confirmPassword" class="invalid-feedback">{{ errors.confirmPassword }}</p>+ </div>+ <NuxtLink to="/login" class="login-link">Already have an account? Log in</NuxtLink>+ <button type="submit" class="btn">Sign Up</button>+ <p v-if="errors.general" class="invalid-feedback">{{ errors.general }}</p>+ </form></div></template><script setup lang="ts">-import AppHeader from './_components/AppHeader.vue';-import AppFooter from './_components/AppFooter.vue';--const router = useRouter();-const userStore = useUserStore();-definePageMeta({+ layout: 'public',middleware: [function redirectSignupDisabled() {const config = useRuntimeConfig();@@ -80,6 +71,9 @@ definePageMeta({],});+const router = useRouter();+const userStore = useUserStore();+// Form fieldsconst username = ref('');const email = ref('');@@ -122,15 +116,6 @@ async function createAccount(username: string, email: string, password: string)</script><style scoped lang="scss">-.container {- display: flex;- width: 95%;- margin: 0 auto;- flex-direction: column;- justify-content: space-between;- padding-top: 1.5rem;-}-.body-container {display: flex;width: 100%;@@ -145,29 +130,17 @@ h1 {font-size: 2.5em;}-/* ===== Form ===== */form {width: 100%;}.form-group {- display: flex;- width: 100%;- flex-direction: column;- gap: 6px;margin-bottom: 0.8rem;-- label {- font-size: 0.95rem;- font-weight: 600;- }}input {- width: 100%;padding: 0.6rem;border: 2px solid var(--border);- border-radius: var(--radius-md);font-size: 1rem;background: var(--surface-base);transition:@@ -177,7 +150,6 @@ input {&:focus {border-color: var(--primary);box-shadow: 0 0 0 3px rgb(var(--primary-rgb), 0.1);- outline: none;}}@@ -236,15 +208,13 @@ input {}}-/* ===== Links ===== */.login-link {display: block;- margin: 1.5rem 0;+ margin: 1rem 0;font-weight: 500;color: var(--primary);text-align: center;transition: color $transition-fast ease;- text-decoration: none;&:hover {color: var(--primary-dark);@@ -252,7 +222,6 @@ input {}}-/* ===== Buttons ===== */.btn {width: 100%;padding: 0.9rem;diff --git a/frontend/app/pages/reference/documentation.vue b/frontend/app/pages/reference/documentation.vuenew file mode 100644index 00000000..df7416b3--- /dev/null+++ b/frontend/app/pages/reference/documentation.vue@@ -0,0 +1,443 @@+<template>+ <div class="body-container">+ <article class="markdown-preview modern-theme document-content" style="font-size: 16px; font-family: Poppins; line-height: 1.5">+ <h1 id="alexandrie-setup-guide">Alexandrie Setup Guide</h1>+ <p>This guide explains how to set up, configure, and deploy the Alexandrie stack.</p>+ <p>+ It covers both <strong>local development</strong> and <strong>production deployment</strong>, including how to configure environment variables, connect+ the different services, and handle HTTPS with a reverse proxy.+ </p>+ <hr />+ <h2 id="overview-of-the-stack">Overview of the Stack</h2>+ <p>The Alexandrie stack consists of four main services, defined in the <code>docker-compose.yml</code> file:</p>+ <table>+ <thead>+ <tr>+ <th>Service</th>+ <th>Description</th>+ </tr>+ </thead>+ <tbody>+ <tr>+ <td><strong>MySQL</strong></td>+ <td>Relational database used to store user data and metadata.</td>+ </tr>+ <tr>+ <td><strong>RustFS</strong></td>+ <td>S3-compatible object storage used for file and media storage.</td>+ </tr>+ <tr>+ <td><strong>Backend</strong></td>+ <td>The Go-based API server providing authentication, storage, and access control.</td>+ </tr>+ <tr>+ <td><strong>Frontend</strong></td>+ <td>A Nuxt 4 web app that communicates with the backend via REST API.</td>+ </tr>+ </tbody>+ </table>+ <p>All services are connected through a dedicated Docker network (<code>alexandrie-network</code>).</p>+ <hr />+ <h2 id="quick-start">Quick Start</h2>+ <p>For local testing, you can run Alexandrie directly using the provided <code>docker-compose.yml</code>:</p>+ <p>+ Download the <code>docker-compose.yml</code> file from the repository:+ <a href="https://github.com/Smaug6739/Alexandrie/blob/main/docker-compose.yml">https://github.com/Smaug6739/Alexandrie/blob/main/docker-compose.yml</a>+ and run:+ </p>++ <div class="code-block-wrapper">+ <button class="code-copy-btn">+ <svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 -960 960 960" width="18px">+ <path+ d="M160-80q-33 0-56.5-23.5T80-160v-480q0-33 23.5-56.5T160-720h80v-80q0-33 23.5-56.5T320-880h480q33 0 56.5 23.5T880-800v480q0 33-23.5 56.5T800-240h-80v80q0 33-23.5 56.5T640-80H160Zm160-240h480v-480H320v480Z"+ ></path>+ </svg>+ </button>+ <pre><code class="hljs language-bash">docker compose up+</code></pre>+ </div>+ <p>Once the containers are running:</p>+ <ul>+ <li>Frontend β <a href="http://localhost:8200">http://localhost:8200</a></li>+ <li>Backend API β <a href="http://localhost:8201">http://localhost:8201</a></li>+ <li>Object Storage (RustFS) β <a href="http://localhost:9000">http://localhost:9000</a></li>+ </ul>+ <p><em>Note: No default account is created. You can register a new user directly from the frontend.</em></p>+ <h2 id="configuration-(environment-variables)">Configuration (Environment Variables)</h2>+ <p>+ To customize the setup (ports, domains, security, feature flags, production deployment), you can create a <code>.env</code> file next to+ <code>docker-compose.yml</code>.+ </p>+ <p>+ The <code>.env</code> file template can be found here:+ <a href="https://github.com/Smaug6739/Alexandrie/blob/main/.env.example">https://github.com/Smaug6739/Alexandrie/blob/main/.env.example</a>+ </p>+ <p>Only the variables defined in <code>.env.example</code> are officially supported.</p>+ <h3 id="1.-public-urls-%26-global-access">1. Public URLs & Global Access</h3>++ <div class="code-block-wrapper">+ <button>+ <svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 -960 960 960" width="18px">+ <path+ d="M160-80q-33 0-56.5-23.5T80-160v-480q0-33 23.5-56.5T160-720h80v-80q0-33 23.5-56.5T320-880h480q33 0 56.5 23.5T880-800v480q0 33-23.5 56.5T800-240h-80v80q0 33-23.5 56.5T640-80H160Zm160-240h480v-480H320v480Z"+ ></path>+ </svg>+ </button>+ <pre><code class="hljs language-env">FRONTEND_URL=http://localhost:8200+API_URL=http://localhost:8201+CDN_URL=http://localhost:9005++CDN_ENDPOINT=/alexandrie/+</code></pre>+ </div>+ <p>These variables define how clients (browsers) reach your services.</p>+ <ul>+ <li><code>FRONTEND_URL</code>: The public URL for the frontend service.</li>+ <li><code>API_URL</code>: The public URL for the backend API service.</li>+ <li><code>CDN_URL</code>: The public URL for the object storage service (RustFS).</li>+ <li>+ <code>CDN_ENDPOINT</code>: The path prefix under which files are exposed. You probably want to keep this as /alexandrie/ to match the bucket name,+ change it only if you changed the bucket name or if you have configured a reverse proxy path.<br />+ Final URL are constructed as: <code><CDN_URL><CDN_ENDPOINT><object-path></code><br />+ If you have a problem with files URL just open devtools in your browser and check the actual URL used to load files and then adjust these variables+ accordingly.+ </li>+ </ul>+ <h3 id="2.-application-feature-flags">2. Application Feature Flags</h3>++ <div class="code-block-wrapper">+ <button class="code-copy-btn">+ <svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 -960 960 960" width="18px">+ <path+ d="M160-80q-33 0-56.5-23.5T80-160v-480q0-33 23.5-56.5T160-720h80v-80q0-33 23.5-56.5T320-880h480q33 0 56.5 23.5T880-800v480q0 33-23.5 56.5T800-240h-80v80q0 33-23.5 56.5T640-80H160Zm160-240h480v-480H320v480Z"+ ></path>+ </svg>+ </button>+ <pre><code class="hljs language-env">CONFIG_DISABLE_LANDING=false+CONFIG_DISABLE_SIGNUP=false+CONFIG_DISABLE_NATIVE_LOGIN=false+</code></pre>+ </div>+ <p>These variables control specific features of the application (useful for private deployments, internal tools etc.).</p>+ <ul>+ <li>+ <code>CONFIG_DISABLE_LANDING</code>: If set to <code>true</code>, the landing page is disabled, and users are redirected to the login page. The+ default is <code>false</code>.+ </li>+ <li>+ <code>CONFIG_DISABLE_SIGNUP</code>: If set to <code>true</code>, new user registrations are disabled (in frontend + backend for security). The default+ is <code>false</code>.+ </li>+ <li>+ <code>CONFIG_DISABLE_NATIVE_LOGIN</code>: If set to <code>true</code>, the native username/password login method is disabled. This is useful if you+ want to enforce OIDC or other external authentication methods. The default is <code>false</code>.+ </li>+ </ul>+ <h3 id="3.-backend-api-%E2%80%94-runtime-%26-security">3. Backend API β Runtime & Security</h3>++ <div class="code-block-wrapper">+ <button class="code-copy-btn">+ <svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 -960 960 960" width="18px">+ <path+ d="M160-80q-33 0-56.5-23.5T80-160v-480q0-33 23.5-56.5T160-720h80v-80q0-33 23.5-56.5T320-880h480q33 0 56.5 23.5T880-800v480q0 33-23.5 56.5T800-240h-80v80q0 33-23.5 56.5T640-80H160Zm160-240h480v-480H320v480Z"+ ></path>+ </svg>+ </button>+ <pre><code class="hljs language-env">BACKEND_EXTERNAL_PORT=8201+COOKIE_DOMAIN=localhost:8200+ALLOW_UNSECURE=true+JWT_SECRET=your-secure-jwt-secret-key-change-this-in-production+</code></pre>+ </div>+ <p>These variables configure the backend API service.</p>+ <ul>+ <li><code>BACKEND_EXTERNAL_PORT</code>: The port exposed on your host machine for the Backend API service.</li>+ <li>+ <code>COOKIE_DOMAIN</code> (IMPORTANT): This variable defines where authentication cookies are valid.<br />+ It should match with the common domain used by both frontend and backend services.<br />+ Example: If your frontend is at <code>frontend.yourdomain.com</code> and your backend API is at <code>api.yourdomain.com</code>, then set+ <code>COOKIE_DOMAIN=yourdomain.com</code>.<br />+ <strong>Rules:</strong>+ <ul>+ <li>Must match with the highest common domain between the frontend and the backend. See #286 for more details.</li>+ <li>Must NOT include protocol (http:// or https://)</li>+ <li>If misconfigured, login will appear to work but users will be instantly logged out</li>+ </ul>+ </li>+ <li>+ <code>ALLOW_UNSECURE</code>: If set to <code>true</code>, HTTP connections are allowed (useful for local and dev). In production, it is recommended to+ set this to <code>false</code> to enforce HTTPS.+ </li>+ <li>+ <code>JWT_SECRET</code>: Secret key used to sign JWT tokens. You should change this to a random long string correcly generated (with openssl or+ similar) in production for security. Changing this value will invalidate all existing sessions.+ </li>+ </ul>+ <h3 id="4.-database-%E2%80%94-mysql">4. Database β MySQL</h3>++ <div class="code-block-wrapper">+ <button class="code-copy-btn">+ <svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 -960 960 960" width="18px">+ <path+ d="M160-80q-33 0-56.5-23.5T80-160v-480q0-33 23.5-56.5T160-720h80v-80q0-33 23.5-56.5T320-880h480q33 0 56.5 23.5T880-800v480q0 33-23.5 56.5T800-240h-80v80q0 33-23.5 56.5T640-80H160Zm160-240h480v-480H320v480Z"+ ></path>+ </svg>+ </button>+ <pre><code class="hljs language-env">MYSQL_EXTERNAL_PORT=3307+MYSQL_DATABASE=alexandrie+MYSQL_USER=alexandrie+MYSQL_PASSWORD=password+MYSQL_ROOT_PASSWORD=rootpassword+</code></pre>+ </div>+ <p>These variables configure the MySQL database service.</p>+ <ul>+ <li><code>MYSQL_EXTERNAL_PORT</code>: The port exposed on your host machine for the MySQL service.</li>+ <li><code>MYSQL_DATABASE</code>: The name of the default database created for Alexandrie.</li>+ <li><code>MYSQL_USER</code>: The username for the default Alexandrie database user.</li>+ <li><code>MYSQL_PASSWORD</code>: The password for the default Alexandrie database user.</li>+ <li><code>MYSQL_ROOT_PASSWORD</code>: The password for the MySQL root user.</li>+ </ul>+ <h3 id="5.-object-storage-%E2%80%94-s3-(rustfs-%2F-minio-compatible)-(optional%2C-leave-empty-to-disable)">+ <a class="header-anchor" href="#5.-object-storage-%E2%80%94-s3-(rustfs-%2F-minio-compatible)-(optional%2C-leave-empty-to-disable)" aria-hidden="true"+ >#</a+ >+ 5. Object Storage β S3 (RustFS / MinIO-compatible) (optional, leave empty to disable)+ </h3>++ <div class="code-block-wrapper">+ <button class="code-copy-btn">+ <svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 -960 960 960" width="18px">+ <path+ d="M160-80q-33 0-56.5-23.5T80-160v-480q0-33 23.5-56.5T160-720h80v-80q0-33 23.5-56.5T320-880h480q33 0 56.5 23.5T880-800v480q0 33-23.5 56.5T800-240h-80v80q0 33-23.5 56.5T640-80H160Zm160-240h480v-480H320v480Z"+ ></path>+ </svg>+ </button>+ <pre><code class="hljs language-env">RUSTFS_EXTERNAL_PORT=9005++RUSTFS_ACCESS_KEY=alexandrie-key+RUSTFS_SECRET_KEY=alexandrie-secret++MINIO_BUCKET=alexandrie+</code></pre>+ </div>+ <p>These variables configure the RustFS object storage service.</p>+ <ul>+ <li><code>RUSTFS_EXTERNAL_PORT</code>: The port exposed on your host machine for the RustFS service.</li>+ <li><code>RUSTFS_ACCESS_KEY</code>: The access key for the RustFS S3-compatible API.</li>+ <li><code>RUSTFS_SECRET_KEY</code>: The secret key for the RustFS S3-compatible API.</li>+ <li>+ <code>MINIO_BUCKET</code>: The name of the default bucket created for Alexandrie. Note that this bucket name should match the+ <code>CDN_ENDPOINT</code> variable in the backend configuration. By default, it is set to <code>alexandrie</code> and the backend will create+ <code>alexandrie</code> and <code>alexandrie-backups</code> buckets.+ </li>+ </ul>+ <h3 id="6.-email-%E2%80%94-smtp-(optional)">6. Email β SMTP (optional)</h3>++ <div class="code-block-wrapper">+ <button class="code-copy-btn">+ <svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 -960 960 960" width="18px">+ <path+ d="M160-80q-33 0-56.5-23.5T80-160v-480q0-33 23.5-56.5T160-720h80v-80q0-33 23.5-56.5T320-880h480q33 0 56.5 23.5T880-800v480q0 33-23.5 56.5T800-240h-80v80q0 33-23.5 56.5T640-80H160Zm160-240h480v-480H320v480Z"+ ></path>+ </svg>+ </button>+ <pre><code class="hljs language-env">SMTP_HOST=+SMTP_MAIL=+SMTP_PASSWORD=+</code></pre>+ </div>+ <p>Used only for password reset emails. Leave empty to disable email features (default).</p>+ <ul>+ <li><code>SMTP_HOST</code>: The SMTP server host.</li>+ <li><code>SMTP_MAIL</code>: The email address used to send emails.</li>+ <li><code>SMTP_PASSWORD</code>: The password for the SMTP email account.</li>+ </ul>+ <h3 id="7.-frontend-%E2%80%94-nuxt">7. Frontend β Nuxt</h3>++ <div class="code-block-wrapper">+ <button class="code-copy-btn">+ <svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 -960 960 960" width="18px">+ <path+ d="M160-80q-33 0-56.5-23.5T80-160v-480q0-33 23.5-56.5T160-720h80v-80q0-33 23.5-56.5T320-880h480q33 0 56.5 23.5T880-800v480q0 33-23.5 56.5T800-240h-80v80q0 33-23.5 56.5T640-80H160Zm160-240h480v-480H320v480Z"+ ></path>+ </svg>+ </button>+ <pre><code class="hljs language-env">FRONTEND_EXTERNAL_PORT=8200+</code></pre>+ </div>+ <p>The port exposed on the host for the frontend container.</p>+ <p>In production, this is usually only accessed by a reverse proxy.</p>+ <h2 id="production-deployment-notes">Production Deployment Notes</h2>+ <p>In production, you should:</p>+ <ul>+ <li>NOT expose MySQL or RustFS directly</li>+ <li>Use a reverse proxy (Nginx, Traefik, Caddy)</li>+ <li>Terminate HTTPS at the proxy</li>+ </ul>+ <h2 id="additional-configuration-%26-advanced-setup">Additional Configuration & Advanced Setup</h2>+ <h3 id="custom-configuations---config.toml">Custom configuations - config.toml</h3>+ <p>+ For advanced configuration options for backend you can create your own <code>config.toml</code> file with the same structure as the default one (in+ <code>backend/config.toml</code>) and add the following environment variable to your <code>.env</code> file:+ </p>++ <div class="code-block-wrapper">+ <button class="code-copy-btn">+ <svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 -960 960 960" width="18px">+ <path+ d="M160-80q-33 0-56.5-23.5T80-160v-480q0-33 23.5-56.5T160-720h80v-80q0-33 23.5-56.5T320-880h480q33 0 56.5 23.5T880-800v480q0 33-23.5 56.5T800-240h-80v80q0 33-23.5 56.5T640-80H160Zm160-240h480v-480H320v480Z"+ ></path>+ </svg>+ </button>+ <pre><code class="hljs language-env">CONFIG_PATH=./config.toml # Path to your custom config.toml file+</code></pre>+ </div>+ <p>This allows you to customize advanced settings not covered by environment variables (such as default values, logging levels, supported files etc).</p>+ <h3 id="oidc-integration">OIDC Integration</h3>+ <p>Open ID Connect (OIDC) is supported since version 8.5.0. You can setup up to 10 providers using environment variables to the backend.</p>+ <p>First you have to generate client ID and client secret from your provider (refer to their doc or ask questions in discussions / discord)</p>+ <p>+ Then you have to configure the redirect URI (in the provider interface with this value):+ <code>https://your-alexandrie-frontend/login/oidc/callback</code>+ </p>+ <p>To config a provider you have to fill 4 variables:</p>++ <div class="code-block-wrapper">+ <button class="code-copy-btn">+ <svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 -960 960 960" width="18px">+ <path+ d="M160-80q-33 0-56.5-23.5T80-160v-480q0-33 23.5-56.5T160-720h80v-80q0-33 23.5-56.5T320-880h480q33 0 56.5 23.5T880-800v480q0 33-23.5 56.5T800-240h-80v80q0 33-23.5 56.5T640-80H160Zm160-240h480v-480H320v480Z"+ ></path>+ </svg>+ </button>+ <pre><code class="hljs language-env">OIDC_{i}_CONFIG_URL=https://yourdomain.com/.well-known/openid-configuration+OIDC_{i}_CLIENT_ID=+OIDC_{i}_CLIENT_SECRET=+OIDC_{i}_PROVIDER_NAME= # e.g. Google, Discord, Microsoft...+</code></pre>+ </div>+ <p>+ <em>Replace <code>{i}</code> with a number between 1 to 10</em>+ </p>+ <p>+ To setup these variables to your configuration you have to edit the <code>docker-compose.yml</code> and add variables to the backend config (direct+ values or a reference to your env file) like this for example:+ </p>++ <div class="code-block-wrapper">+ <button class="code-copy-btn">+ <svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 -960 960 960" width="18px">+ <path+ d="M160-80q-33 0-56.5-23.5T80-160v-480q0-33 23.5-56.5T160-720h80v-80q0-33 23.5-56.5T320-880h480q33 0 56.5 23.5T880-800v480q0 33-23.5 56.5T800-240h-80v80q0 33-23.5 56.5T640-80H160Zm160-240h480v-480H320v480Z"+ ></path>+ </svg>+ </button>+ <pre><code class="hljs language-yml"><span class="hljs-attr">OIDC_1_CONFIG_URL:</span> <span class="hljs-string">${OIDC_1_CONFIG_URL}</span>+<span class="hljs-attr">OIDC_1_CLIENT_ID:</span> <span class="hljs-string">${OIDC_1_CLIENT_ID}</span>+<span class="hljs-attr">OIDC_1_CLIENT_SECRET:</span> <span class="hljs-string">${OIDC_1_CLIENT_SECRET}</span>+<span class="hljs-attr">OIDC_1_PROVIDER_NAME:</span> <span class="hljs-string">${OIDC_1_PROVIDER_NAME}</span>+</code></pre>+ </div>+ <h3 id="s3-%2F-minio-%E2%80%94-tls%2C-https-and-custom-certificate-authorities">S3 / Minio β TLS, HTTPS and Custom Certificate Authorities</h3>+ <p>+ Alexandrie connects to the S3-compatible storage (RustFS / MinIO...) using an internal backend client. This client supports HTTPS, custom certificate+ authorities (CA), and explicit TLS configuration.+ </p>+ <p>This section explains how TLS is handled and how to configure it correctly.</p>+ <h4 id="https-vs-http-(minio_secure)">HTTPS vs HTTP (MINIO_SECURE)</h4>++ <div class="code-block-wrapper">+ <button class="code-copy-btn">+ <svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 -960 960 960" width="18px">+ <path+ d="M160-80q-33 0-56.5-23.5T80-160v-480q0-33 23.5-56.5T160-720h80v-80q0-33 23.5-56.5T320-880h480q33 0 56.5 23.5T880-800v480q0 33-23.5 56.5T800-240h-80v80q0 33-23.5 56.5T640-80H160Zm160-240h480v-480H320v480Z"+ ></path>+ </svg>+ </button>+ <pre><code class="hljs language-env">MINIO_SECURE=true|false+</code></pre>+ </div>+ <p>+ This variable controls whether HTTPS (TLS) is used at all when the backend connects to the S3 endpoint. It must explicitly match how your S3 server is+ exposed.+ </p>+ <ul>+ <li><code>true</code> β HTTPS is used (default)</li>+ <li><code>false</code> β HTTP is used (no TLS)</li>+ </ul>+ <h4 id="custom-certificate-authorities-(minio_ca_path)">Custom Certificate Authorities (MINIO_CA_PATH)</h4>+ <p>If your S3 endpoint uses a certificate signed by an internal or private certificate authority, you must explicitly provide this CA to the backend.</p>++ <div class="code-block-wrapper">+ <button class="code-copy-btn">+ <svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 -960 960 960" width="18px">+ <path+ d="M160-80q-33 0-56.5-23.5T80-160v-480q0-33 23.5-56.5T160-720h80v-80q0-33 23.5-56.5T320-880h480q33 0 56.5 23.5T880-800v480q0 33-23.5 56.5T800-240h-80v80q0 33-23.5 56.5T640-80H160Zm160-240h480v-480H320v480Z"+ ></path>+ </svg>+ </button>+ <pre><code class="hljs language-env">MINIO_CA_PATH=/path/to/ca-certificate.pem+</code></pre>+ </div>+ <ul>+ <li>The file must contain the CA certificate (root or intermediate), in PEM format</li>+ <li>This CA will be added to the system trust store used by the S3 client</li>+ <li>This is the recommended and secure way to handle internal PKI</li>+ </ul>+ <p>+ <em+ >Note: if you are using docker containers, you must mount this file into the backend container using a volume in <code>docker-compose.yml</code>.</em+ >+ </p>+ <p><em>TLS Verification Bypass (Not Recommended)</em></p>++ <div class="code-block-wrapper">+ <button class="code-copy-btn">+ <svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 -960 960 960" width="18px">+ <path+ d="M160-80q-33 0-56.5-23.5T80-160v-480q0-33 23.5-56.5T160-720h80v-80q0-33 23.5-56.5T320-880h480q33 0 56.5 23.5T880-800v480q0 33-23.5 56.5T800-240h-80v80q0 33-23.5 56.5T640-80H160Zm160-240h480v-480H320v480Z"+ ></path>+ </svg>+ </button>+ <pre><code class="hljs language-env">MINIO_INSECURE_TLS=true|false+</code></pre>+ </div>+ <p>This option disables TLS certificate verification while still using HTTPS.</p>+ <ul>+ <li>The connection remains encrypted</li>+ <li>Certificate validation (CA + hostname) is skipped</li>+ </ul>+ <div class="yellow custom-block">+ <p class="custom-block-title">Security warning</p>+ <div class="custom-block-content">+ <p>This option should only be used for:</p>+ <ul>+ <li>temporary debugging</li>+ <li>local testing environments</li>+ <li>It is not recommended for production use.</li>+ </ul>+ </div>+ </div>+ </article>+ </div>+</template>++<script setup lang="ts">+definePageMeta({+ layout: 'public',+});+</script>++<style lang="scss" scoped>+.body-container {+ display: flex;+ width: 100%;+ max-width: 1000px;+ margin: 2rem auto;+ align-items: center;+ flex-direction: column;+ justify-content: center;+}+</style>diff --git a/frontend/app/pages/reference/privacy.vue b/frontend/app/pages/reference/privacy.vuenew file mode 100644index 00000000..6cb9f1a1--- /dev/null+++ b/frontend/app/pages/reference/privacy.vue@@ -0,0 +1,63 @@+<template>+ <article class="markdown-preview modern-theme document-content" style="font-size: 16px; font-family: Poppins; line-height: 1.5">+ <h1 id="privacy-policy---alexandrie" tabindex="-1">+ <a class="header-anchor" href="#privacy-policy---alexandrie" aria-hidden="true">#</a> Privacy Policy - Alexandrie+ </h1>+ <h2 id="introduction" tabindex="-1"><a class="header-anchor" href="#introduction" aria-hidden="true">#</a> Introduction</h2>+ <p>+ Alexandrie is an open-source project. We care about your privacy and only collect the data necessary to make the platform work. This policy explains what+ information we collect, how we use it, and your rights as a user.+ </p>+ <h2 id="data-we-collect" tabindex="-1"><a class="header-anchor" href="#data-we-collect" aria-hidden="true">#</a> Data We Collect</h2>+ <ul>+ <li>+ <strong>Account information</strong>: To create an account, we require a unique username and a password. You can choose any username β it does not need+ to be linked to your real identity.+ </li>+ <li>+ <strong>Optional personal details</strong>: You may choose to provide an avatar, first name, last name, or email address (for password recovery). None+ of these are required.+ </li>+ <li><strong>Login data</strong>: For security and maintenance, we store standard session information such as IP address, login dates, and times.</li>+ <li>+ <strong>External login</strong>: Depending on configuration, users may log in via an external OIDC provider. In this case, some basic profile+ information may be shared from that provider.+ </li>+ </ul>+ <h2 id="how-we-use-your-data" tabindex="-1"><a class="header-anchor" href="#how-we-use-your-data" aria-hidden="true">#</a> How We Use Your Data</h2>+ <ul>+ <li>To allow you to log in and use the platform.</li>+ <li>To manage sessions and maintain security.</li>+ <li>To personalize your interface if you choose to provide optional details.</li>+ <li>To help you recover your account if you provided an email.</li>+ </ul>+ <h2 id="your-rights" tabindex="-1"><a class="header-anchor" href="#your-rights" aria-hidden="true">#</a> Your Rights</h2>+ <ul>+ <li><strong>Account deletion</strong>: You can delete your account at any time. All your data will be removed.</li>+ <li><strong>Data export</strong>: You can request a backup of your data at any time.</li>+ <li><strong>Optional data</strong>: You are not required to provide personal details beyond the username and password.</li>+ </ul>+ <h2 id="security" tabindex="-1"><a class="header-anchor" href="#security" aria-hidden="true">#</a> Security</h2>+ <p>We take reasonable measures to protect your data. Passwords are stored securely, and session data is handled with standard security practices.</p>+ <h2 id="changes-to-this-policy" tabindex="-1"><a class="header-anchor" href="#changes-to-this-policy" aria-hidden="true">#</a> Changes to This Policy</h2>+ <p>Since Alexandrie is an open-source project, this policy may be updated occasionally. We recommend checking this page periodically for updates.</p>+ <h2 id="contact-%26-code-source" tabindex="-1">+ <a class="header-anchor" href="#contact-%26-code-source" aria-hidden="true">#</a> Contact & Code source+ </h2>+ <p>If you have questions about the application you can contact us by email: <a href="mailto:[email protected]">[email protected]</a></p>+ <p>Code source of the application is available here: <a href="https://github.com/Smaug6739/Alexandrie">https://github.com/Smaug6739/Alexandrie</a>.</p>+ </article>+</template>++<script setup lang="ts">+definePageMeta({+ layout: 'public',+});+</script>++<style scoped>+article {+ max-width: 1000px;+ margin: 2rem auto 0 auto;+}+</style>