diff --git a/custom-words.txt b/custom-words.txt index d097b99a..7bf409d6 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -42,6 +42,7 @@ proxied refactorings roadmap roadmaps +rustup sandboxed SARIF SAST diff --git a/docs/getting-started/clients/index.md b/docs/getting-started/clients/index.md index d914ba33..9f067327 100644 --- a/docs/getting-started/clients/index.md +++ b/docs/getting-started/clients/index.md @@ -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: diff --git a/docs/getting-started/clients/troubleshooting.md b/docs/getting-started/clients/troubleshooting.md index b2656903..3d6f290e 100644 --- a/docs/getting-started/clients/troubleshooting.md +++ b/docs/getting-started/clients/troubleshooting.md @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 8 --- # Troubleshooting diff --git a/docs/getting-started/enterprise/_category_.yml b/docs/getting-started/enterprise/_category_.yml index 2db89cee..8e77e7bd 100644 --- a/docs/getting-started/enterprise/_category_.yml +++ b/docs/getting-started/enterprise/_category_.yml @@ -1,2 +1,2 @@ label: "Enterprise" -position: 4 +position: 6 diff --git a/docs/getting-started/clients/mobile/android/android-sdk.png b/docs/getting-started/mobile/android/android-sdk.png similarity index 100% rename from docs/getting-started/clients/mobile/android/android-sdk.png rename to docs/getting-started/mobile/android/android-sdk.png diff --git a/docs/getting-started/clients/mobile/android/index.md b/docs/getting-started/mobile/android/index.md similarity index 93% rename from docs/getting-started/clients/mobile/android/index.md rename to docs/getting-started/mobile/android/index.md index 9d79645f..e6670cdc 100644 --- a/docs/getting-started/clients/mobile/android/index.md +++ b/docs/getting-started/mobile/android/index.md @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/docs/getting-started/clients/mobile/index.md b/docs/getting-started/mobile/index.md similarity index 98% rename from docs/getting-started/clients/mobile/index.md rename to docs/getting-started/mobile/index.md index ec2d4af6..0940fc89 100644 --- a/docs/getting-started/clients/mobile/index.md +++ b/docs/getting-started/mobile/index.md @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 4 --- # Mobile diff --git a/docs/getting-started/clients/mobile/ios/index.mdx b/docs/getting-started/mobile/ios/index.mdx similarity index 99% rename from docs/getting-started/clients/mobile/ios/index.mdx rename to docs/getting-started/mobile/ios/index.mdx index e48a969e..5e5dd5a8 100644 --- a/docs/getting-started/clients/mobile/ios/index.mdx +++ b/docs/getting-started/mobile/ios/index.mdx @@ -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) diff --git a/docs/getting-started/clients/mobile/ios/new-project-options.png b/docs/getting-started/mobile/ios/new-project-options.png similarity index 100% rename from docs/getting-started/clients/mobile/ios/new-project-options.png rename to docs/getting-started/mobile/ios/new-project-options.png diff --git a/docs/getting-started/clients/mobile/ios/run-debug.png b/docs/getting-started/mobile/ios/run-debug.png similarity index 100% rename from docs/getting-started/clients/mobile/ios/run-debug.png rename to docs/getting-started/mobile/ios/run-debug.png diff --git a/docs/getting-started/clients/mobile/ios/signing-and-capabilities.png b/docs/getting-started/mobile/ios/signing-and-capabilities.png similarity index 100% rename from docs/getting-started/clients/mobile/ios/signing-and-capabilities.png rename to docs/getting-started/mobile/ios/signing-and-capabilities.png diff --git a/docs/getting-started/clients/mobile/ios/troubleshoot-generic-simulator.png b/docs/getting-started/mobile/ios/troubleshoot-generic-simulator.png similarity index 100% rename from docs/getting-started/clients/mobile/ios/troubleshoot-generic-simulator.png rename to docs/getting-started/mobile/ios/troubleshoot-generic-simulator.png diff --git a/docs/getting-started/clients/mobile/watchos/index.mdx b/docs/getting-started/mobile/watchos/index.mdx similarity index 100% rename from docs/getting-started/clients/mobile/watchos/index.mdx rename to docs/getting-started/mobile/watchos/index.mdx diff --git a/docs/getting-started/sdk/index.md b/docs/getting-started/sdk/index.md new file mode 100644 index 00000000..f4478f1e --- /dev/null +++ b/docs/getting-started/sdk/index.md @@ -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/ diff --git a/docs/getting-started/tools/index.md b/docs/getting-started/tools/index.md index a0b82923..b8992441 100644 --- a/docs/getting-started/tools/index.md +++ b/docs/getting-started/tools/index.md @@ -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