mirror of
https://github.com/bitwarden/server.git
synced 2024-11-26 12:55:17 +01:00
100 lines
3.1 KiB
Markdown
100 lines
3.1 KiB
Markdown
<p align="center">
|
|
<img src="https://i.imgur.com/lcoBQEZ.png" alt="bitwarden" />
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://ci.appveyor.com/project/bitwarden/core/branch/master" target="_blank">
|
|
<img src="https://ci.appveyor.com/api/projects/status/github/bitwarden/core?branch=master&svg=true" alt="appveyor build" />
|
|
</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 Core project contains the APIs, database, and other infrastructure items needed for the "backend" of all other bitwarden projects.
|
|
|
|
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
|
|
|
|
- [.NET Core 2.x SDK](https://www.microsoft.com/net/download/core)
|
|
- [SQL Server 2016 or 2017](https://docs.microsoft.com/en-us/sql/index) (2017 for cross-platform)
|
|
|
|
*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 -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
|
|
|
|
<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/).
|
|
|
|
### 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/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`](SECURITY.md) file.
|