Skip to content

Commit 377269a

Browse files
nalakawulanalakawula
authored
Chore/update release title (#2)
* Create proper README Signed-off-by: sumarsono <sumarsono.wongbandar@gmail.com> * Deploy Vaultwarden withour docker example Signed-off-by: sumarsono <sumarsono.wongbandar@gmail.com> * Fix release title Signed-off-by: sumarsono <sumarsono.wongbandar@gmail.com> * fix release page link Signed-off-by: sumarsono <sumarsono.wongbandar@gmail.com> --------- Signed-off-by: sumarsono <sumarsono.wongbandar@gmail.com>
1 parent 644c394 commit 377269a

File tree

3 files changed

+182
-4
lines changed

3 files changed

+182
-4
lines changed

‎.github/workflows/build.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,6 @@ jobs:
3434
docker rm -v "$id"
3535
tar -cvf vaultwarden-"$arch2".tar.gz "$arch2/vaultwarden" "$arch2/web-vault"
3636
done
37-
gh release create "$latestVersion" --repo "$GITHUB_REPOSITORY" --notes "Update to [$latestVersion](https://github.com/dani-garcia/vaultwarden/releases/tag/$latestVersion)" *.tar.gz
37+
gh release create "$latestVersion" --title "$latestVersion" --repo "$GITHUB_REPOSITORY" --notes "Update to [$latestVersion](https://github.com/dani-garcia/vaultwarden/releases/tag/$latestVersion)" *.tar.gz
3838
env:
3939
GH_TOKEN: ${{ github.token }}

‎README.md‎

Lines changed: 60 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,62 @@
1-
# VaultWarden Binary
1+
# Vaultwarden Binary
22

3-
Extracts binaries from [VaultWarden](https://github.com/dani-garcia/vaultwarden) Docker images automatically.
3+
This repository contains the pre-compiled binary releases of [Vaultwarden](https://github.com/dani-garcia/vaultwarden), the lightweight Bitwarden server API implementation written in Rust. This project aims to provide users with easy access to the Vaultwarden binaries for various platforms.
44

5-
Downloads are available in [releases](https://github.com/1f349/vaultwarden-binary/releases)
5+
## Table of Contents
6+
7+
- [Vaultwarden Binary](#vaultwarden-binary)
8+
- [Table of Contents](#table-of-contents)
9+
- [Introduction](#introduction)
10+
- [Download](#download)
11+
- [Installation](#installation)
12+
- [Usage](#usage)
13+
- [Configuration](#configuration)
14+
15+
16+
## Introduction
17+
18+
Vaultwarden is an alternative implementation of the Bitwarden server API. It is lightweight and perfect for self-hosting password management solutions. This repository hosts the binary releases of Vaultwarden for various operating systems, allowing users to quickly download and run Vaultwarden without the need to compile it from source.
19+
20+
## Download
21+
22+
You can download the latest version of the Vaultwarden binary for your platform from the [releases page](https://github.com/1f349/vaultwarden-binary/releases).
23+
24+
Available platforms:
25+
- Linux
26+
- Windows
27+
- macOS
28+
29+
## Installation
30+
31+
### Linux
32+
33+
1. Download the binary from the [releases page](https://github.com/1f349/vaultwarden-binary/releases).
34+
2. Make the binary executable:
35+
```bash
36+
chmod +x vaultwarden
37+
```
38+
3. Move the binary to a directory in your PATH, for example:
39+
```bash
40+
sudo mv vaultwarden /usr/local/bin/
41+
```
42+
43+
## Usage
44+
45+
Once the binary is installed, you can start the Vaultwarden server by running:
46+
47+
```bash
48+
vaultwarden
49+
```
50+
By default, Vaultwarden will listen on port 8080. You can access the web vault by navigating to http://localhost:8080 in your web browser.
51+
52+
## Configuration
53+
54+
Vaultwarden can be configured using environment variables. For a full list of configuration options, refer to the official Vaultwarden documentation.
55+
56+
Example:
57+
58+
```bash
59+
export ROCKET_PORT=8080
60+
export DATABASE_URL=data/db.sqlite3
61+
vaultwarden
62+
```

‎example/deploy-vaultwarden-without-docker.md‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
# Deploy Vaultwarden Without Docker
2+
3+
This is an example on how to deploy Vaultwarden without Docker. We will use Vaultwarden binary with systemd service.
4+
5+
## Directory Structure
6+
7+
```bash
8+
/opt/vaultwarden
9+
|-- .env
10+
|-- bin
11+
| `-- vaultwarden
12+
|-- lib
13+
|-- data
14+
`-- web-vault
15+
```
16+
17+
## .env File
18+
19+
Refer to [.env.template](https://github.com/dani-garcia/vaultwarden/blob/main/.env.template)
20+
21+
```bash
22+
ROCKET_ADDRESS=0.0.0.0
23+
ROCKET_PORT=8080
24+
DOMAIN=https://your-domain.tld
25+
LOG_LEVEL=error
26+
ORG_EVENTS_ENABLED=true
27+
EVENTS_DAYS_RETAIN=7
28+
29+
# https://github.com/dani-garcia/vaultwarden/wiki/Enabling-admin-page#using-argon2
30+
ADMIN_TOKEN='please-fill-it'
31+
ADMIN_RATELIMIT_SECONDS=300
32+
ADMIN_RATELIMIT_MAX_BURST=3
33+
ADMIN_SESSION_LIFETIME=20
34+
35+
# Behind cloudflare proxy
36+
# IP_HEADER=CF-Connecting-IP
37+
38+
SIGNUPS_ALLOWED=false
39+
SIGNUPS_VERIFY=true
40+
SIGNUPS_DOMAINS_WHITELIST=your-domain.tld
41+
42+
# https://github.com/dani-garcia/vaultwarden/wiki/SMTP-Configuration
43+
SMTP_HOST=""
44+
SMTP_FROM=""
45+
SMTP_FROM_NAME=""
46+
SMTP_SECURITY=starttls
47+
SMTP_PORT=587
48+
SMTP_USERNAME=""
49+
SMTP_PASSWORD=""
50+
51+
# https://github.com/dani-garcia/vaultwarden/wiki/Enabling-Mobile-Client-push-notification
52+
PUSH_ENABLED=true
53+
PUSH_INSTALLATION_ID=""
54+
PUSH_INSTALLATION_KEY=""
55+
56+
# I am using PostgresSQL instead of sqlite
57+
DATABASE_URL=postgresql://db_user:db_pass@db_host:5432/db_name
58+
59+
DATA_FOLDER=data
60+
WEB_VAULT_ENABLED=true
61+
WEB_VAULT_FOLDER=web-vault/
62+
```
63+
64+
## Systemd Service
65+
66+
Refer to [vaultwarden/wiki](https://github.com/dani-garcia/vaultwarden/wiki/Setup-as-a-systemd-service)
67+
68+
```bash
69+
sudo nano /etc/systemd/system/vaultwarden.service
70+
```
71+
72+
```ini
73+
[Unit]
74+
Description=Vaultwarden
75+
Documentation=https://github.com/dani-garcia/vaultwarden
76+
77+
# In this example I use PostgreSQL instead of sqlite
78+
After=network.target postgresql.service
79+
Requires=postgresql.service
80+
81+
82+
[Service]
83+
# The user/group vaultwarden is run under. the working directory (see below) should allow write and read access to this user/group
84+
User=your-user
85+
Group=your-user
86+
# Use an environment file for configuration.
87+
EnvironmentFile=/opt/vaultwarden/.env
88+
# The location of the compiled binary
89+
ExecStart=/opt/vaultwarden/bin/vaultwarden
90+
# Set reasonable connection and process limits
91+
LimitNOFILE=1048576
92+
LimitNPROC=64
93+
# Isolate vaultwarden from the rest of the system
94+
PrivateTmp=true
95+
PrivateDevices=true
96+
ProtectHome=true
97+
ProtectSystem=strict
98+
# Only allow writes to the following directory and set it to the working directory (user and password data are stored here)
99+
WorkingDirectory=/opt/vaultwarden/lib
100+
ReadWritePaths=/opt/vaultwarden/lib
101+
```
102+
103+
To make systemd aware of your new file or any changes you made, run
104+
105+
```bash
106+
$ sudo systemctl daemon-reload
107+
```
108+
109+
To start this "service", run
110+
111+
```bash
112+
$ sudo systemctl start vaultwarden.service
113+
```
114+
115+
To enable autostart, run
116+
117+
```bash
118+
$ sudo systemctl enable vaultwarden.service
119+
```
120+
121+
In the same way you can `stop`, `restart` and `disable` the service.

0 commit comments

Comments
 (0)