Go to file

Robert Kaussow 849f27f7c5 [SKIP CI] fix formatting		2020-02-01 23:25:13 +01:00
overlay	cleanup	2020-02-01 23:14:37 +01:00
.drone.jsonnet	remove microbadger and add minimal docs	2020-02-01 17:54:03 +01:00
.drone.yml	remove microbadger and add minimal docs	2020-02-01 17:54:03 +01:00
.gitignore	add simple wait-for script	2020-02-01 18:34:59 +01:00
CHANGELOG.md	initial commit	2020-01-16 22:36:08 +01:00
docker-compose.yml	add missing wait-for call	2020-02-01 19:09:53 +01:00
Dockerfile.amd64	add simple wait-for script	2020-02-01 18:34:59 +01:00
LICENSE	small fixes	2020-02-01 17:59:14 +01:00
manifest.tmpl	add build commands	2020-01-17 01:34:14 +01:00
README.md	[SKIP CI] fix formatting	2020-02-01 23:25:13 +01:00

README.md

bitwarden_rs

This is a custom Docker image for bitwarden_rs. Bitwarden_rs is a Bitwarden server API implementation written in Rust compatible with upstream Bitwarden clients, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal.

Warning

: While bitwarden_rs does not allow to compile binaries with multi DB providers, this build will only work with a PostgreSQL database backend.

Usage

Docker Compose

Compatible with docker-compose v3 schemas.

---
version: '3'

services:
  postgres:
    container_name: bitwardenrs_postgres
    image: postgres
    environment:
      POSTGRES_DB: bitwarden
      POSTGRES_PASSWORD: pass
      POSTGRES_USER: user

  bitwardenrs:
    container_name: bitwardenrs
    image: xoxys/bitwardenrs:latest
    depends_on:
      - postgres
    ports:
      - "80:8080"
    environment:
      ITWARDENRS_WAIT_FOR_HOST: bitwardenrs_postgres
      BITWARDENRS_WAIT_FOR_PORT: 5432
      BITWARDENRS_DATABASE_URL: postgresql://user:pass@bitwardenrs_postgres:5432/bitwarden
      BITWARDENRS_ADMIN_TOKEN: test

volumes:
  bitwardenrs_data:
    driver: local

Configuration

BITWARDENRS_DATABASE_URL=
# Wait for database host. If you don't set a Host and Port
# Bitwarden will start immediately.
BITWARDENRS_WAIT_FOR_HOST=
BITWARDENRS_WAIT_FOR_PORT=
BITWARDENRS_WAIT_FOR_TIMEOUT=15

BITWARDENRS_TEMPLATES_FOLDER=
BITWARDENRS_RELOAD_TEMPLATES=False

BITWARDENRS_IP_HEADER=X-Client-IP

BITWARDENRS_ICON_CACHE_TTL=2592000
BITWARDENRS_ICON_CACHE_NEGTTL=259200

BITWARDENRS_WEB_VAULT_ENABLED=True
BITWARDENRS_WEBSOCKET_ENABLED=False

BITWARDENRS_EXTENDED_LOGGING=True
BITWARDENRS_LOG_LEVEL=Info

BITWARDENRS_DISABLE_ICON_DOWNLOAD=False
BITWARDENRS_ICON_DOWNLOAD_TIMEOUT=10
BITWARDENRS_ICON_BLACKLIST_REGEXL=
BITWARDENRS_ICON_BLACKLIST_NON_GLOBAL_IPS=True

BITWARDENRS_DISABLE_2FA_REMEMBER=False
BITWARDENRS_SIGNUPS_ALLOWED=True
BITWARDENRS_SIGNUPS_VERIFY=False
BITWARDENRS_SIGNUPS_VERIFY_RESEND_TIME=3600
BITWARDENRS_SIGNUPS_VERIFY_RESEND_LIMIT=6
BITWARDENRS_SIGNUPS_DOMAINS_WHITELIST=

BITWARDENRS_INVITATIONS_ALLOWED=True

# Set an indicidual admin token to enable the admin UI
BITWARDENRS_ADMIN_TOKEN=

BITWARDENRS_PASSWORD_ITERATIONS=100000
BITWARDENRS_SHOW_PASSWORD_HINT=True
BITWARDENRS_DOMAIN=http://localhost/

BITWARDENRS_AUTHENTICATOR_DISABLE_TIME_DRIFT=False

# If you dont set a smtp host, all other smpt settings will be ignored
BITWARDENRS_SMTP_HOST=
BITWARDENRS_SMTP_FROM=
BITWARDENRS_SMTP_FROM_NAME=Bitwarden_RS
BITWARDENRS_SMTP_PORT=587
BITWARDENRS_SMTP_SSL=True
BITWARDENRS_SMTP_USERNAME=
BITWARDENRS_SMTP_PASSWORD=
BITWARDENRS_SMTP_AUTH_MECHANISM=Plain
BITWARDENRS_SMTP_TIMEOUT=15

License

This project is licensed under the GNU v3.0 - see the LICENSE file for details.

Maintainers and Contributors

Robert Kaussow