mirror of
https://github.com/bitwarden/server.git
synced 2024-11-29 13:25:17 +01:00
fd42b227b3
* 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
105 lines
3.6 KiB
Markdown
105 lines
3.6 KiB
Markdown
<p align="center">
|
|
<img src="https://github.com/bitwarden/brand/blob/master/screenshots/apps-combo-logo.png" alt="Bitwarden" />
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://ci.appveyor.com/project/bitwarden/server/branch/master" target="_blank">
|
|
<img src="https://ci.appveyor.com/api/projects/status/n4ntjp7ag1uwxckd/branch/master?svg=true" alt="appveyor build" />
|
|
</a>
|
|
<a href="https://hub.docker.com/u/bitwarden/" target="_blank">
|
|
<img src="https://img.shields.io/docker/pulls/bitwarden/api.svg" alt="DockerHub" />
|
|
</a>
|
|
<a href="https://gitter.im/bitwarden/Lobby" target="_blank">
|
|
<img src="https://badges.gitter.im/bitwarden/Lobby.svg" alt="gitter chat" />
|
|
</a>
|
|
</p>
|
|
|
|
-------------------
|
|
|
|
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](https://github.com/bitwarden/server/blob/master/SETUP.md) for a step-by-step guide to set up your own local development server.
|
|
|
|
### Requirements
|
|
|
|
- [.NET Core 3.1 SDK](https://www.microsoft.com/net/download/core)
|
|
- [SQL Server 2017](https://docs.microsoft.com/en-us/sql/index)
|
|
|
|
*These dependencies are free to use.*
|
|
|
|
### Recommended Development Tooling
|
|
|
|
- [Visual Studio](https://www.visualstudio.com/vs/) (Windows and macOS)
|
|
- [Visual Studio Code](https://code.visualstudio.com/) (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
|
|
|
|
<p align="center">
|
|
<a href="https://hub.docker.com/u/bitwarden/" target="_blank">
|
|
<img src="https://i.imgur.com/SZc8JnH.png" alt="docker" />
|
|
</a>
|
|
</p>
|
|
|
|
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](https://hub.docker.com/u/bitwarden/).
|
|
|
|
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](https://www.docker.com/community-edition#/download)
|
|
- [Docker Compose](https://docs.docker.com/compose/install/) (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`](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`](SECURITY.md) file. We also run a program on [HackerOne](https://hackerone.com/bitwarden).
|