mirror of
https://github.com/bitwarden/server.git
synced 2024-11-22 12:15:36 +01:00
b13dda2799
* EF Database Support Init (#1221) * scaffolding for ef support * deleted old postgres repos * added tables to oncreate * updated all the things to .NET 5 * Addition to #1221: Migrated DockerFiles from dotnet/3.1 to 5.0 (#1223) * Migrated DockerFiles from dotnet/3.1 to 5.0 * Migrated SSO/Dockerfile from dotnet 3.1 to 5.0 Co-authored-by: Daniel James Smith <djsmith85@users.noreply.github.com> * EFDatabaseSupport: Updated links and description in README.md and SETUP.md (#1232) * Updated requirements in README.md * Updated link to documentation of app-secrets * upgraded dotnet version to 5.0 * Ef database support implementation examples (#1265) * mostly finished testing the user repo * finished testing user repo * finished org, user, ssoconfig, and ssouser ef implementations * removed unused prop * fixed a sql file * fixed a spacing issue * fixed a spacing issue * removed extra database creation * refactoring * MsSql => SqlServer * refactoring * code review fixes * build fix * code review * continued attempts to fix the the build * skipped another test * finished all create test * initial pass at several repos * continued building out repos * initial pass at several repos * initial pass at device repo * initial pass at collection repo * initial run of all Entity Framework implementations * signup, signin, create/edit ciphers works * sync working * all web vault pages seem to load with 100% 200s * bulkcopy, folders, and favorites * group and collection management * sso, groups, emergency access, send * get basic creates matching on all repos * got everything building again post merge * removed some IDE config files * cleanup * no more notimplemented methods in the cipher repo * no more not implementeds everywhere * cleaned up schema/navigation properties and fixed tests * removed a sql comment that was written in c# style * fixed build issues from merge * removed unsupported db providers * formatting * code review refactors * naming cleanup for queries * added provider methods * cipher repo cleanup * implemented several missing procedures from the EF implementation surround account revision dates, keys, and storage * fixed the build * added a null check * consolidated some cipher repo methods * formatting fix * cleaned up indentation of queries * removed .idea file * generated postgres migrations * added mysql migrations * formatting * Bug Fixes & Formatting * Formatting * fixed a bug with bulk import when using MySql * code review fixes * fixed the build * implemented new methods * formatting * fixed the build * cleaned up select statements in ef queries * formatting * formatting * formatting Co-authored-by: Daniel James Smith <djsmith85@users.noreply.github.com>
107 lines
4.0 KiB
Markdown
107 lines
4.0 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.
|
|
|
|
## 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 5.0 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).
|
|
|
|
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).
|