Getting Started

Vaultwarden is a lightweight, self-hosted Bitwarden-compatible password manager server written in Rust. It implements the Bitwarden server API and works with all official Bitwarden client apps (browser extensions, desktop apps, and mobile apps). Available as an open web service in Eyevinn Open Source Cloud, Vaultwarden lets you keep full control of your passwords and secrets without relying on third-party cloud storage.

Prerequisites

Step 1: Create a PostgreSQL database

Vaultwarden requires a PostgreSQL database to store user accounts, vault items, and organization data. Navigate to the PostgreSQL service in the Eyevinn OSC web console. Click "Create psql-db" and enter a name and password.

Based on the IP and port shown, your database URL is: postgres://postgres:<password>@<IP>:<PORT>/postgres

Step 2: Store the database URL as a secret

Navigate to the Vaultwarden service and go to the "Service Secrets" tab. Click "New Secret" and create:

  • dburl with the full PostgreSQL connection URL from Step 1

Step 3: Create the Vaultwarden instance

Go to the "My vaultwarden" tab and click "Create vaultwarden". Fill in:

  • Name: a name for your instance (alphanumeric only)
  • DatabaseUrl: {{secrets.dburl}}
  • AdminToken: a strong random string to secure the admin panel (e.g. generate one with openssl rand -base64 48)
  • SignupsAllowed: true to allow new users to register, or false to invite-only

Click on the instance card when the status is green and "running".

Step 4: Create your account

Open the instance URL in your browser. Click "Create Account" to register your first user account and set your master password.

To access the admin panel, append /admin to your instance URL and enter the admin token you configured in Step 3.

Important: The admin token grants full access to user management and server settings. Store it securely.

Step 5: Install the Bitwarden client

Vaultwarden is fully compatible with official Bitwarden clients. After installing a client (browser extension, desktop, or mobile app), point it at your self-hosted server:

  1. On the login screen, click the region selector (globe icon) or gear icon
  2. Select "Self-hosted" and enter your Vaultwarden instance URL
  3. Log in with the account you created in Step 4

Usage Example

Connect to Vaultwarden programmatically using the Bitwarden CLI:

# Install the Bitwarden CLI
npm install -g @bitwarden/cli

# Configure the CLI to use your self-hosted instance
bw config server https://<your-instance-url>

# Log in
bw login

# List all items in your vault
bw list items

CLI

# First create a PostgreSQL database
osc create birme-osc-postgresql mydb -o PostgresPassword="mypassword"

# Create the Vaultwarden instance
osc create dani-garcia-vaultwarden myvault \
  -o databaseUrl="postgres://postgres:mypassword@<IP>:<PORT>/postgres" \
  -o adminToken="<your-admin-token>" \
  -o signupsAllowed=true

Resources