zackshomelab/bitwarden

Instructions on how to deploy a self-hosted instance of BitWarden.

BitWarden Self-Host Installation Instructions

This repository is essentially a 'How-To' guide on deploying a self-hosted BitWarden instance. These instructions are targeted towards IT Personel who would like to deploy BitWarden into their organization.

These instructions demonstrate the following:

• How-To Create the Virtual Machine
• How-To Install the Operating System
• How-To Configure the Operating System
• How-To Install BitWarden
• How-To Automate the Maintenance for BitWarden
• Admin Training Documentation
• User Training Documentation

Getting Started

• Click the 'Wiki' button at the top to browse the chapters or simply click go to this URL: https://github.com/ZacksHomeLab/BitWarden/wiki

• Installation Overview: https://github.com/ZacksHomeLab/BitWarden/wiki/BitWarden-Self-Host-Installation-Overview

• Chapter 1: https://github.com/ZacksHomeLab/BitWarden/wiki/Chapter-1:-Deploy-Virtual-Machine

• Chapter 2: https://github.com/ZacksHomeLab/BitWarden/wiki/Chapter-2:-Operating-System-Setup

• Chapter 3: https://github.com/ZacksHomeLab/BitWarden/wiki/Chapter-3:-BitWarden-Application-Setup

• Chapter 4: https://github.com/ZacksHomeLab/BitWarden/wiki/Chapter-4.-BitWarden-Maintenance

• Chapter 5: https://github.com/ZacksHomeLab/BitWarden/wiki/Chapter-5:-Admin-Training

• Chapter 6: https://github.com/ZacksHomeLab/BitWarden/wiki/Chapter-6:-User-Training

bitwarden's Issues

"Failed updating permissions on script file" Error on update-bitwarden.ps1

Let me start out this issue by noting that it's entirely possible I've got something else going on as I've had a selfhosted BW instance for years now so am sorta "side stepping" into this. My primary backups have been and continue to be Veeam based but I am interested in the auto-backup and auto-upgrade scripts. I successfully got the auto-backup script working but am running into the following error when I run the auto-upgrade script:

~$ sudo /usr/bin/pwsh -File "/opt/bitwarden/update-bitwarden.ps1" -PasswordFile /opt/bitwarden/password_file -FinalBackupLocation /backups -LogFile /opt/bitwarden/update-bitwarden.log
Main: Checking preconditions before we start...
Main: Current Core ID: bitwarden/admin:2022.12.0:
Main: Current Web ID: bitwarden/web:2022.12.0:
Main: Downloading latest bitwarden script...
Main: Updating permissions on bitwarden script file /opt/bitwarden-2022-12-28-09-21/bitwarden.sh...                     
WARNING: Main: Failed updating permissions on script file /opt/bitwarden-2022-12-28-09-21/bitwarden.sh.

First glance this seemed to me like a possible permissions issue, but even running as root (sudo su and then run again) I get the same error. I should also note that I got the error while still on v2022.10.0 before just saying screw it and manually upgrading to v2022.12.0. I feel like I might be missing something obvious here, but can't figure out what. Any ideas? Thank you for this awesome contribution to the community!

Documentation notes

Chapter 1
https://github.com/ZacksHomeLab/BitWarden/wiki/Chapter-1:-Deploy-Virtual-Machine

A Gen 2 VM is what should be used.
Gen 2 has better device support.
Supports GPT and UEFI BIOS (instead of just MBR)
Better boot performance as its not initializing a bunch of unneeded IDE virtual controllers.

This also eliminates your Chapter 2 buffer I/o issues you get from the virtual floppy as it will no longer exist.

Office 365 Emails Not Sending When Scripts Run

Hello! Thank you for all your hard work and level of details in this project, you've done a fantastic job! I'm a newbie trying out Docker and various self-hosting projects, and followed your guide and got everything working, except, I'm having a heck of a time with getting the email portion to work. I am using Office 365, and the account is an actual user account, not a shared mailbox. The email works fine when it is coming from BitWarden itself, but it doesn't seem to work with the PS scripts on my Ubuntu Docker host. I've tried using the Send-MailMessage by itself and it works, so I know the service and my credential work. I feel like it's something not being passed through between the various PS functions, but I don't know enough to be able to tell for sure. And it's entirely possible it's something of my own doing, but I was hoping you might have some insight on it or suggestions to try. This is the error I keep getting...

Exception: Send-ZHLBWEmail: Failed sending email due to The SMTP server requires a secure connection or the client was not authenticated. The server response was: 5.7.57 Client not authenticated
to send mail.

Seems straightforward in the message, but as I said I know it works outside of it with Send-MailMessage if I just do a test message. In your guide in Chapter 4, "How-To Configure Email Notifications", all I did there was make sure my global.override.env file was correct, since everything else email-wise in BitWarden seems to work, I assumed that was all that was needed. Am I mistaken and I have to do one of the two options, regardless of if my email in BitWarden was working fine previously? Thanks for any input!