Skip to content

Latest commit

 

History

History
60 lines (47 loc) · 2.29 KB

README.md

File metadata and controls

60 lines (47 loc) · 2.29 KB

(Note: This is still a work in progress. This project is not associated with the Bitwarden project nor 8bit Solutions LLC. Please use gitter or the issue tracker for this repo if you need support. If you need to use the official Bitwarden channels make it clear that you are using a 3rd party backend server)

bitwarden-go

Build Status Gitter chat

A server compatible with the Bitwarden apps and plugins. The server has a small footprint and could be run locally on your computer, a Raspberry Pi or a small VPS. The data is stored in a local SQLite database.

** If you're using an old database you need to add kdf and kdfIterations to your accounts table **

For more information on the protocol you can read the documentation provided by jcs

Usage

Fetching the code

Make sure you have the go package installed. Note: package name may vary based on distribution

You can then run go get github.com/VictorNine/bitwarden-go/cmd/bitwarden-go to fetch the latest code.

Build/Install

Run in your favorite terminal:

cd $GOPATH/src/github.com/VictorNine/bitwarden-go/cmd/bitwarden-go

followed by

go build

or

go install

The former will create a executable named bitwarden-go in the current directory, and go install will build and install the executable bitwarden-go as a system-wide application (located in $GOPATH/bin). Note: From here on, this guide assumes you ran go install

Initalizing the Database

Note: This step only has to be performed once

Run the following to initalize the database:

bitwarden-go -init

This will create a database called db in the directory of the application. Use -location to set a different directory for the database.

Running

To run bitwarden-go, run the following in the terminal:

bitwarden-go

Usage with Flags

To see all current flags and options with the application, run

bitwarden-go -h