Skip to content

Commit

Permalink
chore: update Insomnia Sync doc [INS-3273] (#168)
Browse files Browse the repository at this point in the history
  • Loading branch information
filfreire authored Nov 2, 2023
1 parent 77bb8f4 commit 07ec9a1
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 39 deletions.
Binary file added docs/assets/images/secure-cloud-project.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 16 additions & 39 deletions docs/insomnia/insomnia-sync.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,36 @@
---
layout: article-detail
title: Sync Collections with Insomnia Cloud
title: Cloud Sync
category: "Get Started"
category-url: get-started
---

{:.alert .alert-primary}
**Note**: Version Control Sync applies only to remote **Collections** at this time. Collections use our own Insomnia Cloud for versioning. This feature comes with paid subscriptions. See [Pricing](https://insomnia.rest/pricing) for more information. To learn about Git sync for Documents, refer to [Git Sync](/insomnia/git-sync).
In this section, you will find documentation on [Cloud Sync](#cloud-sync) and [Snapshots](#snapshots).

In this section, you will find documentation on Collections [Sync](#sync) and [Snapshots](#snapshots).
## Cloud Sync

## Sync
Cloud sync provides the following abilities on top of the base Insomnia functionality:

Sync for remote Collections provides the following abilities on top of the base Insomnia functionality:

* Snapshot the contents of a request collection
* Revert a request collection to a previous Snapshot
* Share Snapshots across devices or with members of your team
* Snapshot the contents of projects
* Revert to a previous Snapshot
* Share Snapshots across devices or with members of your organization
* Create and work on separate branches

The main features of sync (once enabled automatically or manually) can be accessed from the dropdown at the top right of the application when you are in a remote Collection.

![With a paid subscription, click on the large branch name button within a Collection.](/assets/images/version-control.png)
_For versioning options on a Collection, click on the large branch name button._

## Enable Sync

On creating a request Collection within a Remote Project, Insomnia will attempt to automatically enable sync and push an initial snapshot.

![Switch to a remote project](/assets/images/switch-remote-project.png)
_Log into your account and switch to the Remote Project where you wish to sync a Collection._
## Enabling sync for projects

### Manually Enable Sync
When creating a new project you will be prompted to pick the **Project Type**.

If Insomnia is unable to or has not automatically enabled sync, then you can manually set this up. First click **Setup Sync** then **Create Local Project**. Then you can create and push your first Snapshot.
![Enabling remote project](/assets/images/secure-cloud-project.jpg)

{:.alert .alert-primary}
**Note**: Can't see the Sync menu? Make sure you're logged in by clicking on the person icon in the top right corner of your application. If you see a logout option, you're logged in. If you still can't see the Sync menu, make sure you're inside a remote Project from the Dashboard.

![Enable Insomnia Cloud within a Collection by clicking the Setup Sync button.](/assets/images/setup-sync.png)
_Enable Insomnia Cloud within a Collection by clicking the Setup Sync button._

When sync is enabled on a Collection inside a Project, all users that have access to the Project also gain access to that Collection. You can manage the members in your Project from the [web dashboard](https://app.insomnia.rest/app/signup/).
Any collections and design documents under a **Secure Cloud** project type will be automatically synced into Insomnia cloud.

## Snapshots

This section provides information on using the paid Snapshot feature for remote Collections. For pricing information, see our [Pricing](https://insomnia.rest/pricing) page.
This section provides information on using the paid Snapshot feature for Secure Cloud Projects. For pricing information, see our [Pricing](https://insomnia.rest/pricing) page.

### Create Snapshot

To create a Snapshot, open a **remote Collection** and click on the branch dropdown menu next to Preferences, and then click **Create Snapshot**. A **Create Snapshot** modal will open.
To create a Snapshot, open a **remote Collection/Design Document** and click on the branch dropdown menu next to Preferences, and then click **Create Snapshot**. A **Create Snapshot** modal will open.

![To create a new Snapshot, click on the branch dropdown next to Preferences and select Create Snapshot.](/assets/images/create-snapshot.png)
_Within a remote Collection, click on the branch dropdown and click on Create Snapshot._
Expand All @@ -71,7 +52,7 @@ Snapshot messages should describe the included changes in as much detail as poss

### Add Changes to a Snapshot

Changes made to a request collection can be added on a granular level. Modifications and deletions to existing requests, folders, etc (AKA objects) will appear under Modified Objects, while new additions will appear under Unversioned Objects and are unselected by default.
Changes made to a request collection/design document can be added on a granular level. Modifications and deletions to existing requests, folders, etc (AKA objects) will appear under Modified Objects, while new additions will appear under Unversioned Objects and are unselected by default.

### Share Snapshots

Expand All @@ -93,18 +74,14 @@ Branches can be useful for many reasons, but the two main use cases are the foll

Branches are managed within the branches dialog. Here, you can create local branches, merge branches, and fetch remote branches.

### Share a Request Collection

To get started sharing workspaces with your team, see [Team Collaboration](/insomnia/team-collaboration).

### Revert to a Previous Snapshot

You can revert a Collection to a previous Snapshot. Find the Snapshot you want to revert to by going to the branch dropdown and clicking on **History**. Then click **Restore** on the Snapshot you want to revert to.
You can revert a Collection/Design Document to a previous Snapshot. Find the Snapshot you want to revert to by going to the branch dropdown and clicking on **History**. Then click **Restore** on the Snapshot you want to revert to.

When you restore a Snapshot, it will show the changes locally and you'll need to manually Snapshot the changes.

## Things to Know

If a team is using mixed versions of Insomnia, and one version supports a type of request (such as gRPC or Websockets) that another version doesn't, then syncing that request type to a Team Collection with Insomnia Cloud may cause the request to be silently deleted when the collection is pulled and updated by different members using different Insomnia versions.
If a team is using mixed versions of Insomnia, and one version supports a type of request (such as gRPC or WebSockets) that another version doesn't, then syncing that request type to a synced Collection/Design Document with Insomnia Cloud may cause the request to be silently deleted when the collection/Design document is pulled and updated by different members using different Insomnia versions.

We highly recommend that teams be on the latest version of Insomnia to avoid losing request data due to version incompatibilities.

1 comment on commit 07ec9a1

@vercel
Copy link

@vercel vercel bot commented on 07ec9a1 Nov 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

insomnia-docs – ./

insomnia-docs-three.vercel.app
insomnia-docs-green-rs.vercel.app
insomnia-docs-git-main-green-rs.vercel.app

Please sign in to comment.