Skip to content

Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.

Update docs installation comparison UI

Leendert de Borstc1f1e9ed85c7
diff --git a/docs/docs/installation/index.mdx b/docs/docs/installation/index.mdx
index 153d4209f..01c722fcb 100644
--- a/docs/docs/installation/index.mdx
+++ b/docs/docs/installation/index.mdx
@@ -4,50 +4,71 @@ hide_table_of_contents: true
---
# Self-host Install
-AliasVault is self-hosted with Docker. There are two ways to install it — pick
-based on **how much you want managed for you** versus how much you want to fit
-into infrastructure you already run.
+AliasVault is self-hosted with Docker. Both methods install the **same
+AliasVault** — they differ only in how much is managed for you versus how much
+fits into infrastructure you already run. Pick the one that matches your setup.
<div className="av-install-choice">
<a className="av-install-card av-install-card--featured" href="./script/">
- <div className="av-install-card__emoji">🚀</div>
- <div className="av-install-card__title">
- Install Script
- <span className="av-install-card__badge">Recommended</span>
+ <span className="av-install-card__badge">Recommended</span>
+ <div className="av-install-card__head">
+ <div className="av-install-card__icon">
+ <svg width="30" height="30" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round">
+ <path d="m4 17 6-6-6-6" />
+ <path d="M12 19h8" />
+ </svg>
+ </div>
+ <div>
+ <h3 className="av-install-card__title">Install Script</h3>
+ <div className="av-install-card__meta">~5 min</div>
+ </div>
</div>
<p className="av-install-card__tagline">
- A fully managed setup. One script spins up every container, gets HTTPS for
+ A fully managed setup. One script spins up multiple containers, handles HTTPS for
you, and gives you CLI helpers for updates and maintenance.
</p>
<ul className="av-install-card__list">
+ <li>AliasVault on its own VPS or LXC</li>
<li>Automatic HTTPS via Let&apos;s Encrypt</li>
<li>Guided updates &amp; migrations</li>
<li>Production-ready defaults</li>
</ul>
- <p className="av-install-card__tagline">
- <strong>Best for:</strong> a fresh VM or VPS dedicated to AliasVault.
+ <p className="av-install-card__bestfor">
+ <strong>Best for</strong> a fresh VM or VPS dedicated to AliasVault.
</p>
<div className="av-install-card__cta">
- <span className="button button--secondary button--outline button--lg">
- Install with the script →
+ <span className="button button--primary button--lg">
+ Install with script →
</span>
</div>
</a>
<a className="av-install-card" href="./docker-compose/">
- <div className="av-install-card__emoji">🛠️</div>
- <div className="av-install-card__title">Docker Compose</div>
+ <div className="av-install-card__head">
+ <div className="av-install-card__icon">
+ <svg width="30" height="30" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round">
+ <rect x="2" y="3" width="20" height="7" rx="1.5" />
+ <rect x="2" y="14" width="20" height="7" rx="1.5" />
+ <path d="M6 6.5h.01M6 17.5h.01" />
+ </svg>
+ </div>
+ <div>
+ <h3 className="av-install-card__title">Docker Compose</h3>
+ <div className="av-install-card__meta">~15 min</div>
+ </div>
+ </div>
<p className="av-install-card__tagline">
- A single all-in-one container you drop into your existing Docker stack.
+ A single all-in-one container you can add to your existing Docker stack.
You bring your own reverse proxy and TLS, and keep full control.
</p>
<ul className="av-install-card__list">
- <li>Fits Portainer, Unraid, Synology &amp; other homelab tools</li>
+ <li>AliasVault as an all-in-one container on your existing Docker host</li>
+ <li>Best for setups on NAS or when using tools like e.g. Portainer</li>
<li>Bring your own TLS (Traefik, Nginx, HAProxy, Caddy…)</li>
<li>Updates via <code>docker pull</code> (occasional manual migrations)</li>
</ul>
- <p className="av-install-card__tagline">
- <strong>Best for:</strong> a NAS or homelab that already runs a reverse proxy and/or other Docker containers.
+ <p className="av-install-card__bestfor">
+ <strong>Best for</strong> a NAS or homelab that already runs a reverse proxy and/or other Docker containers.
</p>
<div className="av-install-card__cta">
<span className="button button--secondary button--outline button--lg">
@@ -57,21 +78,57 @@ into infrastructure you already run.
</a>
</div>
-## Differences
+## Side-by-side comparison
-The two methods install the same version AliasVault: they differ mainly in how TLS, updates, and the surrounding setup is handled.
+Both methods run the same AliasVault version. They differ mainly in how TLS,
+updates, and the surrounding setup are handled.
-| | 🚀 Install Script | 🛠️ Docker Compose |
-|------------------|---------------------------|------------------------------|
-| **TLS/SSL** | Automatic (Let's Encrypt) | Bring your own reverse proxy |
-| **Updates** | Guided via `install.sh` | Manual `docker pull` |
-| **Containers** | Multiple (one per service)| Single all-in-one image |
-| **Best for** | Dedicated VM / VPS | Existing homelab / NAS |
-| **Build from source** | Supported | Pre-built image only |
+<div className="av-compare-wrap">
+ <table className="av-compare">
+ <thead>
+ <tr>
+ <th></th>
+ <th>Install Script</th>
+ <th>Docker Compose</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th scope="row">TLS / HTTPS</th>
+ <td>Automatic via Let&apos;s Encrypt</td>
+ <td>Bring your own reverse proxy</td>
+ </tr>
+ <tr>
+ <th scope="row">Updates</th>
+ <td>Guided via <code>install.sh</code></td>
+ <td>Manual <code>docker pull</code> + migrations</td>
+ </tr>
+ <tr>
+ <th scope="row">Architecture</th>
+ <td>Multiple containers (one per service)</td>
+ <td>Single all-in-one image</td>
+ </tr>
+ <tr>
+ <th scope="row">Reverse proxy</th>
+ <td>Included &amp; configured</td>
+ <td>You provide (Traefik, Nginx, Caddy…)</td>
+ </tr>
+ <tr>
+ <th scope="row">Build from source</th>
+ <td>Supported</td>
+ <td>Pre-built image only</td>
+ </tr>
+ <tr>
+ <th scope="row">Best for</th>
+ <td>Dedicated VM / VPS</td>
+ <td>Existing homelab / NAS</td>
+ </tr>
+ </tbody>
+ </table>
+</div>
-:::tip
-Not sure yet? You can switch later. Both methods use the same Docker bind-mount directories (/database, /certificates, /logs, /secrets), so migration is straightforward.
-Stop or uninstall one method, then follow the installation steps for the other. Your data is preserved.
+:::tip Not sure yet? You can switch later.
+Both methods use the same Docker bind-mount directories (`/database`, `/certificates`, `/logs`, `/secrets`), so migration is straightforward. Stop or uninstall one method, then follow the installation steps for the other. Your data stays preserved.
:::
## Frequently Asked Questions {#faq}
diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css
index fd08d490c..0903206c3 100644
--- a/docs/src/css/custom.css
+++ b/docs/src/css/custom.css
@@ -337,6 +337,7 @@ html[class*='docs-doc-id-installation/index'] .theme-doc-markdown {
/* The whole card is an <a>, so reset link styling and let the body text read
* normally. */
.av-install-card {
+ position: relative;
display: flex;
flex-direction: column;
padding: 1.75rem;
@@ -357,36 +358,61 @@ html[class*='docs-doc-id-installation/index'] .theme-doc-markdown {
text-decoration: none;
}
-/* The recommended option gets a subtle primary-tinted border to draw the eye. */
+/* The recommended option gets a primary-tinted border + a slightly stronger
+ * lift so it reads as the default choice. */
.av-install-card--featured {
border-color: var(--ifm-color-primary);
box-shadow: 0 5px 24px rgba(244, 149, 65, 0.12);
}
-.av-install-card__emoji {
- font-size: 2rem;
- line-height: 1;
- margin-bottom: 0.85rem;
+/* Header row: brand-tinted icon tile next to the title + meta line. Mirrors the
+ * marketing site's feature blocks (icon in a soft primary square). */
+.av-install-card__head {
+ display: flex;
+ align-items: center;
+ gap: 1rem;
+ margin-bottom: 1.1rem;
}
-.av-install-card__title {
+.av-install-card__icon {
+ flex: 0 0 auto;
display: flex;
align-items: center;
- gap: 0.6rem;
+ justify-content: center;
+ width: 56px;
+ height: 56px;
+ border-radius: 12px;
+ color: var(--ifm-color-primary);
+ background: rgba(244, 149, 65, 0.1);
+}
+
+.av-install-card__title {
font-size: 1.25rem;
font-weight: 700;
- margin: 0 0 0.6rem;
+ margin: 0;
+ line-height: 1.2;
}
+.av-install-card__meta {
+ margin-top: 0.2rem;
+ font-size: 0.82rem;
+ font-weight: 500;
+ color: var(--ifm-color-content-secondary);
+}
+
+/* Pinned to the top-right corner of the featured card. */
.av-install-card__badge {
- font-size: 0.68rem;
+ position: absolute;
+ top: 1.1rem;
+ right: 1.1rem;
+ font-size: 0.66rem;
font-weight: 700;
text-transform: uppercase;
- letter-spacing: 0.04em;
- color: var(--ifm-color-primary);
- background: rgba(244, 149, 65, 0.12);
+ letter-spacing: 0.05em;
+ color: #fff;
+ background: var(--ifm-color-primary);
border-radius: 9999px;
- padding: 0.2rem 0.6rem;
+ padding: 0.25rem 0.65rem;
}
.av-install-card__tagline {
@@ -394,10 +420,22 @@ html[class*='docs-doc-id-installation/index'] .theme-doc-markdown {
margin-bottom: 1.1rem;
}
+.av-install-card__bestfor {
+ margin: 0 0 1.5rem;
+ padding-top: 1rem;
+ border-top: 1px solid var(--av-border);
+ font-size: 0.9rem;
+ color: var(--ifm-color-content-secondary);
+}
+
+.av-install-card__bestfor strong {
+ color: var(--ifm-color-content);
+}
+
.av-install-card__list {
list-style: none;
padding: 0;
- margin: 0 0 1.5rem;
+ margin: 0 0 1.25rem;
}
.av-install-card__list li {
@@ -449,6 +487,69 @@ html[class*='docs-doc-id-installation/index'] .theme-doc-markdown {
color: var(--ifm-font-color-base-inverse);
}
+/* ------------------------------------------- Install comparison table -- */
+
+/* Full-width custom comparison table that highlights the recommended column,
+ * replacing Docusaurus' default striped markdown table. The wrapper enables
+ * horizontal scrolling on narrow screens without breaking the rounded frame. */
+.av-compare-wrap {
+ margin: 1.5rem 0;
+ overflow-x: auto;
+ border: 1px solid var(--av-border);
+ border-radius: 14px;
+}
+
+.av-compare {
+ width: 100%;
+ border-collapse: collapse;
+ margin: 0;
+ display: table; /* override Docusaurus' default `display: block` on tables */
+ font-size: 0.95rem;
+}
+
+.av-compare th,
+.av-compare td {
+ padding: 0.85rem 1.1rem;
+ text-align: left;
+ border: none;
+ border-bottom: 1px solid var(--av-border);
+ vertical-align: top;
+}
+
+.av-compare tbody tr:last-child th,
+.av-compare tbody tr:last-child td {
+ border-bottom: none;
+}
+
+/* The header row reads as the structural frame via weight + a heavier bottom
+ * rule, rather than a fill that would echo the gray nav/sidebar and blur the
+ * page together. */
+.av-compare thead th {
+ font-size: 1rem;
+ font-weight: 700;
+ color: var(--ifm-color-content);
+ border-bottom: 2px solid var(--av-border);
+}
+
+/* Row labels stay distinct through bold text + a vertical divider, keeping the
+ * column on the card background instead of a separate tinted block. */
+.av-compare tbody th[scope='row'] {
+ font-weight: 600;
+ color: var(--ifm-color-content);
+ white-space: nowrap;
+ border-right: 1px solid var(--av-border);
+}
+
+.av-compare td {
+ color: var(--ifm-color-content-secondary);
+}
+
+/* Both option columns share the remaining width equally so neither reads as
+ * the "default" — the table presents the two methods side by side, evenly. */
+.av-compare thead th:not(:first-child) {
+ width: 38%;
+}
+
/* ------------------------------------------------ Clickable action cards -- */
/* A responsive grid of "pick a task" cards where the *entire* card is one