Manage Vaultwarden inofficial Bitwarden server with Salt. This formula can compile the binary from source or pull a prebuilt binary* and manage the service and configuration.
Installing and configuring a reverse proxy, fail2ban and possibly log shipping (if you run those on another system) are out of scope for this formula. For hints, see the official docs. I wrote formulae for Rsyslog and Fail2Ban to take care of the latter two. For an example configuration, see :ref:`integration`.
This was written for Debian and RHEL OS families primarily, although adapting the formula should be relatively easy.
Mind that the tests are currently just for show and have not been implemented.
* There is no official one.
Table of Contents
See the full SaltStack Formulas installation and usage instructions.
If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.
If you want to use this formula, please pay attention to the FORMULA
file and/or git tag
,
which contains the currently released version. This formula is versioned according to Semantic Versioning.
See Formula Versioning Section for more details.
If you need (non-default) configuration, please refer to:
- how to configure the formula with map.jinja
- the
pillar.example
file - the Special notes section
- This can compile from source. You can specify any valid git rev as
version
, or keeplatest
. The latter will result in a query to Github releases. - For compilation, a functional Rust toolchain is required on the system. This can either be provided beforehand, by a separate formula or with the inbuilt state. Set
rust_setup: false
to disable any action, to the ID of an sls file to include + require it or totrue
to enable the inbuilt mechanism. - The Web Vault is downloaded from the patched official release (including verifying the signature). Set the web vault version to
false
to disable installation. - You can modify the paths found in
lookup:paths
. If they are different than default,post-map.jinja
will automatically adjust the configuration, so you can focus on the rest.
An example pillar is provided, please see pillar.example. Note that you do not need to specify everything by pillar. Often, it's much easier and less resource-heavy to use the parameters/<grain>/<value>.yaml
files for non-sensitive settings. The underlying logic is explained in map.jinja.
The following states are found in this formula:
Meta-state.
This installs the warden package, manages the warden configuration file and then starts the associated warden service.
Installs the warden package only.
Manages the warden service configuration. Has a dependency on warden.package.
Generates a TLS certificate + key for Vaultwarden. Depends on warden.config.
Installs the web vault from Github releases (by default). Checks signatures before extracting.
Starts the warden service and enables it at boot time. Has a dependency on warden.config.
Installs rustup-init and Rust nightly in order to compile vaultwarden.
- Warning:
- The rustup-init installation pipes the output of
warden.lookup.rustup_init.source
into a shell of the build user. The file hash is verified againstwarden.lookup.rustup_init.source_hash
. You can override the URL inwarden.lookup.rustup_init.source
for a local source.
Meta-state.
Undoes everything performed in the warden
meta-state
in reverse order, i.e.
stops the service,
removes the configuration file and then
uninstalls the package.
Removes the warden package. Has a dependency on warden.config.clean.
Removes the configuration of the warden service and has a dependency on warden.service.clean.
Removes generated Vaultwarden TLS certificate + key. Depends on warden.service.clean.
Removes the Web vault.
Stops the warden service and disables it at boot time.
Uninstalls the Rust toolchain.
Commit message formatting is significant!
Please see How to contribute for more details.
pre-commit is configured for this formula, which you may optionally use to ease the steps involved in submitting your changes.
First install the pre-commit
package manager using the appropriate method, then run bin/install-hooks
and
now pre-commit
will run automatically on each git commit
.
$ bin/install-hooks pre-commit installed at .git/hooks/pre-commit pre-commit installed at .git/hooks/commit-msg
There is a script that semi-autodocuments available states: bin/slsdoc
.
If a .sls
file begins with a Jinja comment, it will dump that into the docs. It can be configured differently depending on the formula. See the script source code for details currently.
This means if you feel a state should be documented, make sure to write a comment explaining it.
Linux testing is done with kitchen-salt
.
- Ruby
- Docker
$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]
Where [platform]
is the platform name defined in kitchen.yml
,
e.g. debian-9-2019-2-py3
.
Creates the docker instance and runs the warden
main state, ready for testing.
Runs the inspec
tests on the actual instance.
Removes the docker instance.
Runs all of the stages above in one go: i.e. destroy
+ converge
+ verify
+ destroy
.
Gives you SSH access to the instance for manual testing.