mirror of
https://github.com/bitwarden/server.git
synced 2024-11-21 12:05:42 +01:00
100 lines
4.7 KiB
Markdown
100 lines
4.7 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://github.com/bitwarden/server/actions/workflows/build.yml?query=branch:master" target="_blank">
|
|
<img src="https://github.com/bitwarden/server/actions/workflows/build.yml/badge.svg?branch=master" alt="Github Workflow build on master" />
|
|
</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/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
|
|
|
|
```
|
|
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
|
|
```
|
|
|
|
## 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 `master` 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/master/TRADEMARK_GUIDELINES.md).
|
|
|
|
### Dotnet-format
|
|
|
|
We recently migrated to using dotnet-format as code formatter. All previous branches will need to updated to avoid large merge conflicts using the following steps:
|
|
|
|
1. Check out your local Branch
|
|
2. Run `git merge 61dc65aa598b1f492d2f0222bb7bf0dd15d116f5`
|
|
3. Resolve any merge conflicts, commit.
|
|
4. Run `dotnet tool run dotnet-format`
|
|
5. Commit
|
|
6. Run `git merge -Xours 23b0a1f9df25058ab29785ecad9a233113c10889`
|
|
7. Push
|
|
|
|
### File Scoped Namespaces
|
|
|
|
We recently migrated to using file scoped namespaces to save some horizontal space. All previous branches will need to update to avoid large merge conflicts using the following steps:
|
|
|
|
1. Check out your local Branch
|
|
2. Run `git merge 9b7aef0763ad14e229b337c3b5b27cb411009792`
|
|
3. Resolve any merge conflicts, commit.
|
|
4. Run `dotnet format`
|
|
5. Commit
|
|
6. Run `git merge -Xours 7f5f010e1eea400300c47f776604ecf46c4b4f2d`
|
|
7. Fix Merge conflicts
|
|
8. Push
|