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

François Van Ingelgom fefda383d1 Allow usage of default override file (#210 ) * Updated run.sh to support default override This is equivalent to run docker-compose in the directory of the project (here "docker"). See: https://docs.docker.com/compose/extends/ Override allows to change some paramaters and extend the original compose file to your own environment (network config, CPU/RAM caps,...) * Updated run.ps1 to support docker override file Same as run.sh * Added conditionals for override file absence I misunderstood the documentation, that file must exist if file is specified on command line, added conditionals to support that case * Update run.ps1 to test for override file presence Same as .sh		2018-02-20 11:09:47 -05:00
scripts	Allow usage of default override file (#210 )	2018-02-20 11:09:47 -05:00
src	RequestSizeLimit for attachment uploads	2018-02-19 08:20:57 -05:00
util	update to net471	2017-12-26 22:34:51 -05:00
.editorconfig	fix name	2017-08-23 22:47:47 -04:00
.gitignore	script fixes for mac	2017-08-19 15:27:57 -04:00
bitwarden-core.sln	convert events processor to new csproj format	2017-12-15 16:18:06 -05:00
build.ps1	src for icons project	2017-10-24 13:58:46 -04:00
build.sh	src for icons project	2017-10-24 13:58:46 -04:00
LICENSE.txt	License changed to AGPLv3	2016-12-03 00:16:25 -05:00
NuGet.Config	initial commit of source	2015-12-08 22:57:38 -05:00
README.md	Update README.md	2017-12-12 16:30:38 -05:00
SECURITY.md	Update SECURITY.md	2017-05-19 12:04:07 -04:00

README.md

bitwarden

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

The core infrastructure 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

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 -f netcoreapp2.0
dotnet run -f netcoreapp2.0

visit http://localhost:5000/alive

Identity

cd src/Identity
dotnet restore
dotnet build -f netcoreapp2.0
dotnet run -f netcoreapp2.0

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/core/master/scripts/bitwarden.sh \
    && sudo chmod u+x bitwarden.sh
./bitwarden.sh install
./bitwarden.sh start
./bitwarden.sh updatedb

Windows

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

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.

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.