From 81ca8d3d40cd3ef2a12d620598c682cf3cbdc25d Mon Sep 17 00:00:00 2001 From: baldnerd Date: Fri, 11 Jul 2025 18:22:42 +0000 Subject: [PATCH] Add disclaimer about running on dedicated appliance. --- README.md | 38 +++++++++++++++++++++----------------- 1 file changed, 21 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 4d73a55..19d7dc4 100644 --- a/README.md +++ b/README.md @@ -15,23 +15,11 @@ A hardened, self-hosted password manager appliance based on Vaultwarden. Designe - 🌐 NGINX reverse proxy + PHP-based first-time activation wizard - 🔑 Multi-user access, browser extensions, mobile app compatibility ---- - -## 📂 Important File Paths - -| Path | Purpose | -|------|---------| -| `/opt/vaultwarden/.env` | Core Vaultwarden environment settings | -| `/var/lib/vaultwarden/.env.user` | User-defined config written via the activation tool | -| `/var/lib/vaultwarden/.setup-complete` | Flag file that disables the activation wizard after first-time config | -| `/opt/vaultwarden/.env.merged` | Combined environment used by the wrapper | -| `/usr/local/bin/vaultwarden` | Vaultwarden binary | -| `/usr/local/bin/vaultwarden-wrapper` | Wrapper that merges .env and .env.user | -| `/etc/systemd/system/vaultwarden.service` | Systemd unit to manage Vaultwarden as a service | -| `/var/www/html/activate/` | First-time activation tool, served via PHP | -| `/var/www/html/vaultinfo/index.html` | Installer-complete welcome page (not currently used) | - ---- +> ⚠️ **Disclaimer** +> This installer is intended **only** for use on a **dedicated appliance or virtual machine** running a clean installation of **Debian 12**. +> It will make system-wide changes, including user/group creation, file permission changes, service overrides, firewall configuration, and package installations. +> **Do not run this script on an existing server or computer system.** +> It does **not** validate your environment or attempt to preserve existing configurations - doing so may cause **data loss** or render your system unusable. ## 🚀 Installation @@ -113,6 +101,22 @@ Use this to clean the system before running a fresh install. **Note:** This does --- +## 📂 File Paths + +| Path | Purpose | +|------|---------| +| `/opt/vaultwarden/.env` | Core Vaultwarden environment settings | +| `/var/lib/vaultwarden/.env.user` | User-defined config written via the activation tool | +| `/var/lib/vaultwarden/.setup-complete` | Flag file that disables the activation wizard after first-time config | +| `/opt/vaultwarden/.env.merged` | Combined environment used by the wrapper | +| `/usr/local/bin/vaultwarden` | Vaultwarden binary | +| `/usr/local/bin/vaultwarden-wrapper` | Wrapper that merges .env and .env.user | +| `/etc/systemd/system/vaultwarden.service` | Systemd unit to manage Vaultwarden as a service | +| `/var/www/html/activate/` | First-time activation tool, served via PHP | +| `/var/www/html/vaultinfo/index.html` | Installer-complete welcome page (not currently used) | + +--- + ## 📜 License This project is licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).