mirror of
https://github.com/bitwarden/server.git
synced 2024-11-27 13:05:23 +01:00
83 lines
3.9 KiB
Markdown
83 lines
3.9 KiB
Markdown
<p align="center">
|
|
<img src="https://github.com/bitwarden/brand/blob/main/screenshots/apps-combo-logo.png" alt="Bitwarden" />
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://github.com/bitwarden/server/actions/workflows/build.yml?query=branch:main" target="_blank">
|
|
<img src="https://github.com/bitwarden/server/actions/workflows/build.yml/badge.svg?branch=main" alt="Github Workflow build on main" />
|
|
</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.
|
|
|
|
## Developer Documentation
|
|
|
|
Please refer to the [Server Setup Guide](https://contributing.bitwarden.com/getting-started/server/guide) in the [Contributing Documentation](https://contributing.bitwarden.com/) for build instructions, recommended tooling, code style tips, and lots of other great information to get you started.
|
|
|
|
## 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
|
|
|
|
```sh
|
|
curl -s -L -o bitwarden.sh \
|
|
"https://func.bitwarden.com/api/dl/?app=self-host&platform=linux" \
|
|
&& chmod +x bitwarden.sh
|
|
./bitwarden.sh install
|
|
./bitwarden.sh start
|
|
```
|
|
|
|
### Windows
|
|
|
|
```cmd
|
|
Invoke-RestMethod -OutFile bitwarden.ps1 `
|
|
-Uri "https://func.bitwarden.com/api/dl/?app=self-host&platform=windows"
|
|
.\bitwarden.ps1 -install
|
|
.\bitwarden.ps1 -start
|
|
```
|
|
|
|
## We're Hiring!
|
|
|
|
Interested in contributing in a big way? Consider joining our team! We're hiring for many positions. Please take a look at our [Careers page](https://bitwarden.com/careers/) to see what opportunities are currently open as well as what it's like to work at Bitwarden.
|
|
|
|
## Contribute
|
|
|
|
Code contributions are welcome! Please commit any pull requests against the `main` branch. Learn more about how to contribute by reading the [Contributing Guidelines](https://contributing.bitwarden.com/contributing/). Check out the [Contributing Documentation](https://contributing.bitwarden.com/) for how to get started with your first contribution.
|
|
|
|
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).
|
|
|
|
No grant of any rights in the trademarks, service marks, or logos of Bitwarden is made (except as may be necessary to comply with the notice requirements as applicable), and use of any Bitwarden trademarks must comply with [Bitwarden Trademark Guidelines](https://github.com/bitwarden/server/blob/main/TRADEMARK_GUIDELINES.md).
|
|
|
|
### Dotnet-format
|
|
|
|
Consider installing our git pre-commit hook for automatic formatting.
|
|
|
|
```bash
|
|
git config --local core.hooksPath .git-hooks
|
|
```
|