Skip to content

Commit

Permalink
Merge branch 'main' into ps/migrations
Browse files Browse the repository at this point in the history
  • Loading branch information
Hinton authored Mar 14, 2024
2 parents 7bad86a + c36ccb3 commit e91c759
Show file tree
Hide file tree
Showing 15 changed files with 57 additions and 16 deletions.
1 change: 1 addition & 0 deletions custom-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ proxied
refactorings
roadmap
roadmaps
rustup
sandboxed
SARIF
SAST
Expand Down
8 changes: 1 addition & 7 deletions docs/getting-started/clients/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,7 @@
sidebar_position: 3
---

# Clients

:::info

For the Mobile application please visit [Mobile](mobile). This page covers the other clients.

:::
# Web clients

This section contains development information for each of the Bitwarden Typescript client
applications:
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/clients/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 7
sidebar_position: 8
---

# Troubleshooting
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/enterprise/_category_.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
label: "Enterprise"
position: 4
position: 6
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Requirements

Before you start, you should have the recommended [Tools and Libraries](../../../tools/index.md)
Before you start, you should have the recommended [Tools and Libraries](../../tools/index.md)
installed. You will also need to install:

1. Visual Studio 2022
Expand Down Expand Up @@ -71,7 +71,7 @@ studio on your Mac natively, you'll need to configure the endpoint addresses usi
### Using Server Tunneling

Instead of configuring your device or emulator, you can instead use a
[proxy tunnel to your local server](../../../server/tunnel.md) and have your app connect to it
[proxy tunnel to your local server](../../server/tunnel.md) and have your app connect to it
directly.

### Push Notifications
Expand All @@ -92,7 +92,7 @@ So, in order to receive notifications while debugging, you have two options:
### Testing Passwordless Locally

Before you can start testing and debugging passwordless logins, make sure your local server setup is
running correctly ([server setup](../../../server/guide.md)). You should also be able to deploy your
running correctly ([server setup](../../server/guide.md)). You should also be able to deploy your
Android app to your device or emulator.

:::note
Expand All @@ -106,7 +106,8 @@ Testing passwordless notifications:

1. Start your local server (`Api`, `Identity`, `Notifications`)
2. Make sure your mobile device can [connect to your local server](#using-server-tunneling)
3. [Start the web client](../../web-vault/index.mdx), as you will need it to make login requests
3. [Start the web client](../../clients/web-vault/index.mdx), as you will need it to make login
requests
4. Deploy the Android app to your device or emulator
5. After deployment, open the app, login to your QA account and activate passwordless login requests
in settings
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 6
sidebar_position: 4
---

# Mobile
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ the bottom popup.
### Using Server Tunneling

Instead of configuring your device or emulator to ignore SSL certificates, you can instead use a
[proxy tunnel to your local server](../../../server/tunnel.md) and have your app connect to it
[proxy tunnel to your local server](../../server/tunnel.md) and have your app connect to it
directly.

### Push Notifications (Live Sync & Passwordless)
Expand Down
44 changes: 44 additions & 0 deletions docs/getting-started/sdk/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
sidebar_position: 5
---

# SDK

Bitwarden provides a public Software Development Kit (SDK) for [Secrets Manager][sm] and an internal
SDK for the Bitwarden [Password Manager][pm]. The SDK is written in Rust and provides bindings for
multiple languages.

## Requirements

- Latest stable version of Rust, preferably installed via [rustup](https://rustup.rs/).
- Node and npm.

See the [Tools and Libraries](../tools/index.md) page for more information.

## Setup instructions

1. Clone the repository:

```bash
git clone https://github.com/bitwarden/sdk.git
cd sdk
```

2. Install the dependencies:

```bash
npm ci
```

## Building the SDK

To build the SDK, run the following command:

```bash
cargo build
```

For more information on how to use the SDK, see the [repository](https://github.com/bitwarden/sdk).

[sm]: https://bitwarden.com/products/secrets-manager/
[pm]: https://bitwarden.com/
3 changes: 2 additions & 1 deletion docs/getting-started/tools/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ environment.
(available via Homebrew: `brew install powershell`)
- [NodeJS](https://nodejs.org/) v18 (preferably using a [node version manager][nvm])
- [NPM](https://www.npmjs.com/) v9 (included with Node)
- [Rust](https://www.rust-lang.org/tools/install) - Used for native desktop components
- [Rust](https://www.rust-lang.org/tools/install) latest stable version - (preferably installed via
[rustup](https://rustup.rs/))
- [Git](https://git-scm.com)
- [Commit signing](../../contributing/commit-signing.mdx) is strongly recommended

Expand Down

0 comments on commit e91c759

Please sign in to comment.