Skip to content

Commit 1a02508

Browse files
committed
[Update] Share Recce Instance page
Signed-off-by: Kent Huang <[email protected]>
1 parent 57f20a8 commit 1a02508

File tree

3 files changed

+39
-24
lines changed

3 files changed

+39
-24
lines changed
60.3 KB
Loading
122 KB
Loading

docs/recce-cloud/share-recce-session-securely.md

Lines changed: 39 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -17,25 +17,55 @@ Recce Cloud allows you to share your Recce validation results with full context,
1717

1818
When you're ready to share your lineage exploration, query results, or validation checklist, simply click **Share** in Recce.
1919

20-
The first time you do this, you'll need to connect your local Recce to Recce Cloud. This requires signing in and setting up an API token. Once connected, Recce Cloud will host your state file securely, allowing you to share a link that others can open in their browsers.
20+
The first time you do this, you'll need to connect your local Recce to Recce Cloud. This requires signing in and setting the connection of local Recce. Once connected, Recce Cloud will host your state file securely, allowing you to share a link that others can open in their browsers.
2121

2222
### 1. Enable Recce Sharing
2323

24-
To start sharing, launch Recce server and click the **Enable Sharing** button.
24+
To start sharing, launch Recce server and click the **Use Recce Cloud** button if you are not connecting Recce with Recce Cloud before.
2525

26-
![Recce Server](../assets/images/recce-cloud/recce-server-enable-sharing-fs8.png){: .shadow}
26+
![Recce Server](../assets/images/recce-cloud/recce-server-use-recce-cloud-for-free.png){: .shadow}
2727

28-
### 2. Sign in to Recce Cloud and retrieve your API token
28+
### 2. Sign in to Recce Cloud and grand access permission
29+
30+
Once your login is successful, your local Recce will be prompted to grant access to Recce Cloud. This step is crucial for enabling the sharing functionality.
31+
32+
![Recce API Token](../assets/images/recce-cloud/recce-cloud-connection-request-approved.png){: .shadow}
33+
34+
### 3. Refresh the page
35+
After granting access, you need to refresh the Recce page. This will ensure that your local Recce is now connected to Recce Cloud and ready for sharing. You'll see the **Share** button, then you can click it to get the link on top.
36+
37+
![Recce Share From Server](../assets/images/recce-cloud/recce-share-from-server-fs8.png){: .shadow}
38+
39+
!!! info
40+
**Note:** If you haven't wanted to start the Recce Server, you can also use the `recce connect-to-cloud` command to connect your local Recce to Recce Cloud. This command will prompt you to sign in and grant access permission.
41+
42+
```bash
43+
recce connect-to-cloud
44+
```
45+
46+
47+
## Configure recce cloud connection manually
48+
If you prefer to set up the Recce Cloud connection manually or your are running Recce under the container environment, you can do so by following these steps:
49+
50+
### 1. Sign in to Recce Cloud and retrieve your API token
2951

3052
Copy your API token from the [personal settings page](https://cloud.datarecce.io/settings#tokens) in Recce Cloud.
3153

3254
![Recce API Token](../assets/images/recce-cloud/setting-page-api-token-fs8.png){: .shadow}
3355

34-
### 3. Add the token to `.recce/profile.yml`
3556

36-
For convenience, you can add your API token in `.recce/profile.yml`, located in your home directory.
57+
### 2. Configure your local Recce to use Recce Cloud
58+
You can launch Recce server with the `--api-token` flag to connect to Recce Cloud. Once the token is set, your api token will be saved in your `~/.recce/profile.yml` file, and you won't need to set it again.
3759

38-
- Find the `.recce` folder in your home directory.
60+
```bash
61+
recce server --api-token <your_api_token>
62+
```
63+
64+
Or you can modify your `~/.recce/profile.yml` file by text editor to include your Recce Cloud API token:
65+
66+
```yaml
67+
api_token: <your_api_token>
68+
```
3969
4070
!!! info
4171
**For Mac/Linux users:** In the terminal, type the following command to navigate to the Recce configuration directory:
@@ -49,27 +79,12 @@ For convenience, you can add your API token in `.recce/profile.yml`, located in
4979
cd ~\.recce
5080
```
5181

52-
- Open `profile.yml` with any text editor to add your token:
53-
```yaml
54-
api_token: <your_api_token>
55-
```
56-
57-
!!! note
58-
Alternatively, for one-time use, you can use `--api-token` flag with the following command:
59-
```bash
60-
recce server --api-token <your_api_token>
61-
```
62-
63-
### 4. Relaunch Recce server
64-
65-
After adding the API token, restarting Recce server is required to load the new configuration.
66-
Once it's running, you'll see the **Share** button, then you can click it to get the link on top.
6782

68-
![Recce Share From Server](../assets/images/recce-cloud/recce-share-from-server-fs8.png){: .shadow}
83+
## Share Recce state file from CLI
6984

7085
You can also use the `recce share` command. If you already have a prepared Recce state file, you can obtain a share link directly through the command line.
7186
```bash
7287
recce share <your_state_file>
73-
recce share --api-token <your_api_token> <your_state_file> # for one-time use
88+
recce share --api-token <your_api_token> <your_state_file> # if you are not connecting Recce with Recce Cloud before
7489
```
7590
![Recce Share From CLI](../assets/images/recce-cloud/recce-share-from-cli.png){: .shadow}

0 commit comments

Comments
 (0)