bitwarden-server

mirror of https://github.com/bitwarden/server.git synced 2024-11-22 12:15:36 +01:00

The core infrastructure backend (API, database, Docker, etc).

api aspnet aspnetcore bitwarden csharp docker dotnet dotnet-core signalr sql sql-server

Go to file

Thomas Rittson fd42b227b3 Update dev setup guide (#1222 ) * Update dev setup guide with current best practice * Minor amendments to setup instructions * Move vault_dev migrator script to its own file * Fix typo, use command line args for SA_PASSWORD * Move setup guide to its own file * fix typo		2021-03-22 07:56:31 +10:00
.github	adding docker to the rc branch workflow (#1183 )	2021-03-04 13:21:27 -08:00
bitwarden_license	Minor release version bump 1.40.0 (#1199 )	2021-03-10 11:19:40 -05:00
scripts	The other outdated link (#1215 )	2021-03-15 09:40:28 -04:00
src	Fix no licence expiration date on self-hosted (#1217 )	2021-03-19 08:05:57 +10:00
test	Use sas token for attachment downloads (#1153 )	2021-02-22 15:35:16 -06:00
util	Update dev setup guide (#1222 )	2021-03-22 07:56:31 +10:00
.editorconfig	fix prefix fields with _	2020-01-15 09:19:15 -05:00
.gitattributes	Added .gitattributes file to files requiring LF endings are properly checked out on Windows. (#380 )	2018-10-18 12:15:41 -04:00
.gitignore	Add docker notary (#1036 )	2020-12-09 10:58:58 -08:00
appveyor.yml	Update swagger config to use proper URL scheme (#744 )	2020-05-21 15:00:03 -04:00
bitwarden-server.sln	add all licenses to solution items	2020-09-04 14:09:30 -04:00
build.sh	Merge SSO and Portal projects	2020-09-04 13:56:08 -04:00
CONTRIBUTING.md	Update dev setup guide (#1222 )	2021-03-22 07:56:31 +10:00
dotnet-tools.json	swagger cli tool fixes	2020-01-10 16:06:44 -05:00
ISSUE_TEMPLATE.md	Update ISSUE_TEMPLATE.md	2018-03-10 14:35:33 -05:00
LICENSE_AGPL.txt	split license file out to support bitwarden licensed code (#912 )	2020-09-04 13:36:22 -04:00
LICENSE_BITWARDEN.txt	split license file out to support bitwarden licensed code (#912 )	2020-09-04 13:36:22 -04:00
LICENSE_FAQ.md	Update LICENSE_FAQ.md	2020-09-05 23:39:50 -04:00
LICENSE.txt	split license file out to support bitwarden licensed code (#912 )	2020-09-04 13:36:22 -04:00
NuGet.Config	initial commit of source	2015-12-08 22:57:38 -05:00
README.md	Update dev setup guide (#1222 )	2021-03-22 07:56:31 +10:00
SECURITY.md	Uppercase Bitwarden	2018-02-27 14:16:19 -05:00
SETUP.md	Update dev setup guide (#1222 )	2021-03-22 07:56:31 +10:00

README.md

The Bitwarden Server project contains the APIs, database, and other core infrastructure items needed for the "backend" of all bitwarden client applications.

The server project is written in C# using .NET Core with ASP.NET Core. The database is written in T-SQL/SQL Server. The codebase can be developed, built, run, and deployed cross-platform on Windows, macOS, and Linux distributions.

Build/Run

Please read the Setup guide for a step-by-step guide to set up your own local development server.

Requirements

These dependencies are free to use.

Recommended Development Tooling

Visual Studio (Windows and macOS)
Visual Studio Code (other)

These tools are free to use.

API

cd src/Api
dotnet restore
dotnet build
dotnet run

visit http://localhost:4000/alive

Identity

cd src/Identity
dotnet restore
dotnet build
dotnet run

visit http://localhost:33657/.well-known/openid-configuration

Deploy

You can deploy Bitwarden using Docker containers on Windows, macOS, and Linux distributions. Use the provided PowerShell and Bash scripts to get started quickly. Find all of the Bitwarden images on Docker Hub.

Full documentation for deploying Bitwarden with Docker can be found in our help center at: https://help.bitwarden.com/article/install-on-premise/

Requirements

Docker
Docker Compose (already included with some Docker installations)

These dependencies are free to use.

Linux & macOS

curl -s -o bitwarden.sh \
    https://raw.githubusercontent.com/bitwarden/server/master/scripts/bitwarden.sh \
    && chmod +x bitwarden.sh
./bitwarden.sh install
./bitwarden.sh start

Windows

Invoke-RestMethod -OutFile bitwarden.ps1 `
    -Uri https://raw.githubusercontent.com/bitwarden/server/master/scripts/bitwarden.ps1
.\bitwarden.ps1 -install
.\bitwarden.ps1 -start

Contribute

Code contributions are welcome! Visual Studio or VS Code is highly recommended if you are working on this project. Please commit any pull requests against the master branch. Please see CONTRIBUTING.md for more info (and feel free to contribute to that guide as well).

Security audits and feedback are welcome. Please open an issue or email us privately if the report is sensitive in nature. You can read our security policy in the SECURITY.md file. We also run a program on HackerOne.