Skip to content

Commit

Permalink
Updated docs to include authentication
Browse files Browse the repository at this point in the history
  • Loading branch information
paustint committed Nov 8, 2024
1 parent cf9e564 commit f032239
Show file tree
Hide file tree
Showing 7 changed files with 90 additions and 1 deletion.
38 changes: 38 additions & 0 deletions apps/docs/docs/getting-started/troubleshooting.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
id: troubleshooting
title: Troubleshoot Connecting to Salesforce
description: Tips on connecting your Salesforce orgs within Jetstream
keywords: [salesforce, salesforce admin, salesforce developer, salesforce automation, salesforce workbench]
sidebar_label: Troubleshoot Connecting to Salesforce
slug: /troubleshooting
---

import OrgTroubleshootingTable from './_org-troubleshooting-table.mdx';

If you are having problems connecting to Salesforce, here are some tips to help you resolve any issues.

### Jetstream IP Addresses

If you need to allow IP addresses for your org, Jetstream will use one of the following three ip addresses:

- `3.134.238.10`
- `3.129.111.220`
- `52.15.118.168`

### Installing Jetstream

After you attempt to connect your Salesforce Org, you should be able to see the connection in Salesforce settings under the **Connected Apps OAuth Usage** option.

From here you have the option to **install** the **Jetstream Connected App**, which will allow you to configure security policies for the connection.

- **Permitted Users** - You can restrict the connection to Admin users.
- **IP Relaxation** - You can configure unique IP address restrictions for this connection.
- **Refresh Token Policy** - Jetstream uses OAuth2 which means there is a short-lived `accessToken` and a long lived `refreshToken` which is used for Jetstream to call Salesforce APIs without ever having direct access to your password.
- You can adjust the settings here based on your desired security preferences.
- **Session Policies** - You can control how you want your session for your `accessToken` and `refreshToken` to behave

Based on your Refresh Token and Session policies, this will control how often you need to re-authorize your org from within Jetstream. If your `refreshToken` expires, then you will need to re-authorize.

### Troubleshooting Tips

<OrgTroubleshootingTable />
19 changes: 19 additions & 0 deletions apps/docs/docs/user-profile-and-settings/settings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
id: settings
title: Settings
description: Settings
keywords: [salesforce, settings, delete account]
sidebar_label: Settings
slug: /user-profile-and-settings/settings
---

On the settings page, you can perform the following actions:

- **Don't Auto-Login on Link Clicks**: When enabled, Jetstream will not automatically log you in to Salesforce when you click on a link in an email.
- Use this if you have SSO configured and clicking Salesforce links from Jetstream asks you to login again.
- When this setting is enabled, clicking Salesforce links will be much faster as long as you are already logged in to Salesforce.
- **Logging**: Enable or disable logging of your Jetstream activity within your browser's console.
- Use this if you are experiencing issues with Jetstream and need to provide logs to the Jetstream team.
- **Delete Account**: Delete your Jetstream account. This action is irreversible.

<img src={require('./settings.png').default} alt="Settings" />
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 23 additions & 0 deletions apps/docs/docs/user-profile-and-settings/user-profile.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
id: user-profile
title: User Profile
description: Keep your Jetstream account secure
keywords:
[salesforce, security, authentication, user profile, user settings, mfa, multi-factor authentication, 2fa, two-factor authentication]
sidebar_label: User Profile
slug: /user-profile-and-settings/user-profile
---

Jetstream offers a variety of security features to help keep your account secure. You can access these features by clicking on your profile icon in the top right corner of the Jetstream app and selecting **Your Profile**.

## User Profile

From the user profile page, you can manage your account settings, including:

- Setting or removing your password
- Connection additional identities so you can login using multiple methods
- Enabling or disabling Multi-Factor Authentication (MFA)
- We currently support MFA via email and authenticator apps
- View all your active sessions and revoke any that you don't recognize

<img src={require('./user-profile.png').default} alt="User profile" />
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions apps/docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ const config: Config = {
organizationName: 'jetstream', // Usually your GitHub org/user name.
projectName: 'jetstream', // Usually your repo name.
trailingSlash: false,

i18n: {
defaultLocale: 'en',
locales: ['en'],
Expand Down Expand Up @@ -60,6 +61,9 @@ const config: Config = {
],
themeConfig:
{
colorMode: {
defaultMode: 'dark',
},
algolia: {
appId: '21D7I5RB7N',
apiKey: '16cff3d92b030f175ef9a30f606a221e',
Expand Down
7 changes: 6 additions & 1 deletion apps/docs/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,12 @@ const sidebar = {
{
type: 'category',
label: 'Getting Started',
items: ['getting-started/overview', 'getting-started/organizations', 'getting-started/feedback'],
items: ['getting-started/overview', 'getting-started/troubleshooting', 'getting-started/organizations', 'getting-started/feedback'],
},
{
type: 'category',
label: 'User Profile and Settings',
items: ['user-profile-and-settings/user-profile', 'user-profile-and-settings/settings'],
},
{
type: 'category',
Expand Down

0 comments on commit f032239

Please sign in to comment.