40 lines
1.7 KiB
Markdown
40 lines
1.7 KiB
Markdown
# Documentation — Vault Warden (Bitwarden-compatible)
|
|
|
|
Brief docs and quick-start for connecting Bitwarden clients and extensions to a self-hosted Vault Warden instance.
|
|
|
|
**Live vault URL:** https://vault.depressionslair.com
|
|
|
|
**Contents**
|
|
- What this repo provides
|
|
- How to preview locally
|
|
- How to configure clients and extensions
|
|
- Notes for contributors
|
|
|
|
**What this repo provides**
|
|
- A simple documentation web page (index.html) with step-by-step instructions for signing up, signing in, and pointing Bitwarden clients/extensions at your Vault Warden server.
|
|
- Small illustrative SVG screenshots in `images/` used to show where to set the Server URL.
|
|
|
|
**Preview locally**
|
|
1. Open a terminal in this repository root.
|
|
2. Start a quick HTTP server (Python 3):
|
|
|
|
```bash
|
|
python -m http.server 8000
|
|
```
|
|
|
|
3. Open http://localhost:8000 in your browser and view `index.html`.
|
|
|
|
**Configure clients & extensions**
|
|
- Browser extensions: install Bitwarden extension, open extension → Settings → set Server URL to `https://vault.depressionslair.com`, then sign in.
|
|
- Desktop apps: open Bitwarden app → Settings → Advanced (or during login) set Server URL to `https://vault.depressionslair.com`.
|
|
- Mobile apps: open Bitwarden app → Settings → Server (or Sync) → set Server URL and sign in.
|
|
|
|
If you want to change the default vault URL shown on the page, edit `index.html` and update the `href` / displayed URL near the top.
|
|
|
|
**Contributing**
|
|
- Fix typos, improve instructions, or replace illustrative SVGs with real screenshots via pull requests.
|
|
- Images live in `images/`.
|
|
|
|
**License**
|
|
This repository contains documentation and images; add a license file if you wish to apply one (e.g., MIT).
|