remove microbadger and add minimal docs
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Robert Kaussow 2020-02-01 17:54:03 +01:00
parent 20db544167
commit ccd9bb22df
4 changed files with 124 additions and 17 deletions

View File

@ -35,6 +35,11 @@ local PipelineBuild(arch='amd64') = {
username: { from_secret: 'docker_username' },
password: { from_secret: 'docker_password' },
},
when: {
ref: [
'refs/pull/**',
],
},
},
{
name: 'publish',
@ -105,13 +110,6 @@ local PipelineNotifications(depends_on=[]) = {
SHORT_DESCRIPTION: 'Rootless Bitwarden_RS - Self-hosted password manager',
},
},
{
name: 'microbadger',
image: 'plugins/webhook',
settings: {
urls: { from_secret: 'microbadger_url' },
},
},
{
image: 'plugins/matrix',
name: 'matrix',

View File

@ -32,6 +32,9 @@ steps:
repo: xoxys/bitwardenrs
username:
from_secret: docker_username
when:
ref:
- refs/pull/**
- name: publish
image: plugins/docker:linux-amd64
@ -101,12 +104,6 @@ steps:
README_PATH: README.md
SHORT_DESCRIPTION: Rootless Bitwarden_RS - Self-hosted password manager
- name: microbadger
image: plugins/webhook
settings:
urls:
from_secret: microbadger_url
- name: matrix
image: plugins/matrix
settings:
@ -135,6 +132,6 @@ depends_on:
---
kind: signature
hmac: c58c688541e6a38f808f59077555afd18721aeeb5ab0087186573e6fb17d0a12
hmac: cb4a70ffd4ac2d24aede3302683a30ef692e81acd332e9365ca384acea8b1bd4
...

101
README.md
View File

@ -1 +1,102 @@
# bitwarden_rs
[![Build Status](https://img.shields.io/drone/build/docker/bitwarden_rs?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/docker/bitwarden_rs)
[![Docker Hub](https://img.shields.io/badge/docker-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/xoxys/bitwardenrs)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
## Usage
### Docker Compose
Compatible with docker-compose v3 schemas.
```Yaml
---
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:
BITWARDENRS_DATABASE_URL: postgresql://user:pass@bitwardenrs_postgres:5432/bitwarden
BITWARDENRS_ADMIN_TOKEN: test
volumes:
bitwardenrs_data:
driver: local
```
## Configuration
```Shell
BITWARDENRS_DATABASE_URL=
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](LICENSE) file for details.
### Maintainers and Contributors
[Robert Kaussow](https://gitea.rknet.org/xoxys)

View File

@ -1,14 +1,25 @@
---
version: '2.1'
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"
volumes:
- bitwardenrs_data:/var/www/app/data
environment:
BITWARDENRS_DATABASE_URL: postgresql://user:pass@bitwardenrs_postgres:5432/bitwarden
BITWARDENRS_ADMIN_TOKEN: test
volumes:
bitwardenrs_data: