Service: Vaultwarden - EyevinnOSC/community GitHub Wiki

Vaultwarden

Vaultwarden (serviceId dani-garcia-vaultwarden, license AGPL-3.0) is a lightweight, self-hosted Bitwarden-compatible password manager server written in Rust. It implements the Bitwarden server API and works with the official Bitwarden client apps (browser extensions, desktop and mobile). In Eyevinn Open Source Cloud (OSC) it is a long-running service instance with up to 10 GiB of storage per instance.

What it can do

  • Store passwords and secrets for individuals and organizations, with full control over where the data lives.
  • Work with all official Bitwarden clients and the Bitwarden CLI.
  • Provide an admin backend (/admin) protected by an admin token.
  • Send email (invitations, password hints, email-based two-factor, notifications) through an SMTP server you configure.
  • Control who can join through open signups or invitations.

Creating an instance

Create a PostgreSQL database first (birme-osc-postgresql) and confirm it is running. Its URL is postgres://postgres:<password>@<IP>:<PORT>/postgres; read address and port with describe-service-instance.

Store the whole database URL as a service secret with create-service-secret (serviceId dani-garcia-vaultwarden), for example dburl, and the admin token as another secret (a strong random string, for example from openssl rand -base64 48). Then call create-service-instance with serviceId: "dani-garcia-vaultwarden". Option names are camelCase (databaseUrl, adminToken, ...):

{
  "name": "myvault",
  "databaseUrl": "{{secrets.dburl}}",
  "adminToken": "{{secrets.vaultadmintoken}}",
  "signupsAllowed": true
}

Wait with wait-for-service-ready or get-instance-status, then open the instance URL and use Create Account to register the first user and set a master password. The admin panel is at /admin on the instance URL; enter the admin token there. The admin token grants full access to user management and server settings, so store it securely.

Equivalent OSC CLI usage:

osc create birme-osc-postgresql mydb -o PostgresPassword="mypassword"
osc create dani-garcia-vaultwarden myvault \
  -o databaseUrl="postgres://postgres:mypassword@<IP>:<PORT>/postgres" \
  -o adminToken="<your-admin-token>" \
  -o signupsAllowed=true

Options

Option Required Type Meaning
name Yes string Name of the instance. Letters, digits and underscore (^\w+$); OSC limits names to 20 characters.
databaseUrl Yes string, sensitive Connection URL of the database storing user accounts, vault items and organization data. Use the PostgreSQL URL postgres://user:password@host:port/dbname. Associated with birme-osc-postgresql.
adminToken No string, sensitive Token that protects the admin backend at /admin. Use a strong random string.
webVaultEnabled No boolean Whether the bundled web vault interface is enabled. The web vault needs HTTPS for the Web Crypto API to work.
smtpHost No string SMTP server hostname or IP address, used for invitations, password hints, email-based two-factor and notification emails.
smtpPort No string Port of the SMTP server.
smtpFrom No string Sender address on all outgoing emails.
smtpUsername No string Username for the SMTP server, if it requires authentication.
smtpPassword No string, sensitive Password for the SMTP server, if it requires authentication.
signupsAllowed No boolean Whether new users can register accounts directly. When false, users can only be added by invitation or by an administrator.
invitationsAllowed No boolean Whether existing users can invite new users to the instance (also used for organization invitations).
showPasswordHint No boolean Whether password hints are shown to users who request them for their master password.

Pass databaseUrl, adminToken and smtpPassword as {{secrets.NAME}}, which must be the entire field value. Defaults for the boolean options are not documented in the catalog and were not verified.

PostgreSQL options (birme-osc-postgresql)

Option Required Type Meaning
name Yes string Instance name.
PostgresPassword Yes string, sensitive Password for the PostgreSQL superuser, for example {{secrets.postgrespwd}}.
PostgresUser No string Superuser name. Defaults to postgres.
PostgresDb No string Default database created at start. Defaults to the same name as the user.
PostgresInitDbArgs No string Extra arguments passed to initdb (for example encoding or locale).
PostgresInitDbSql No string SQL run during database initialization.

Using the instance

Bitwarden clients

After installing a Bitwarden client, point it at your server: on the login screen open the region selector (globe icon) or gear icon, choose Self-hosted, enter your Vaultwarden instance URL, and log in with the account you created.

Bitwarden CLI

npm install -g @bitwarden/cli
bw config server https://<your-instance-url>
bw login
bw list items

Resources

⚠️ **GitHub.com Fallback** ⚠️