diff --git a/README.md b/README.md index 1cb3d6e..7bbf95c 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ You can sync with this repository in all XPipe application instances the same wa - [**Custom**](categories/d3496db5-b709-41f9-abc0-ee0a660fbab9) - **Identities** - [**Synced**](categories/69aa5040-28dc-451e-b4ff-1192ce5e1e3c) +- **Macros** ## Connection list @@ -150,11 +151,11 @@ You have the option to fetch any sensitive information like passwords from outsi In case you choose to store passwords and other secrets within XPipe, all sensitive information is encrypted when it is saved using AES with either: - A dynamically generated key file `vaultkey` (The data can then only be decrypted with that file present) -- A custom passphrase that can be set for your user in the settings menu, combined with the vaultkey file (This option can only as secure as the password you choose) +- A custom passphrase that can be set for your user in the vault settings menu (This option can only as secure as the password you choose) By default, general connection data is not encrypted, only secrets are. So things like hostnames and usernames are stored without encryption, which is in line with many other tools. -There is an available vault setting in the settings menu to encrypt all connection data if you want to do that. +There is an available setting in the vault settings menu to encrypt all connection data if you want to do that. ## Cloning the repository on other systems @@ -179,13 +180,14 @@ Some modern git clients also take care of storing credentials automatically. ### Adding connections to the repository -By default, no categories are set to shared so that you have explicit control on what connections to commit. +By default, no connection categories are set to sync so that you have explicit control on what connections to commit. -To have your connections of a category put inside your git repository, -you either need to right-click the category or click on the `⚙️` icon when hovering over the category -in your `Connections` tab under the category overview on the left side. -Then click on `Add to git repository` to sync the category and connections to your git repository. -This will add all shareable connections in that category to the git repository. +To have your connections of a category put inside your git repository, you first need to change its sync configuration. +In your `Connections` tab under the category overview on the left side, you can open the category configuration menu either by right-clicking the category or click on the `⚙️` icon when hovering over the category, and then clicking on the `🔧` configure button. + +Then, set the `Sync with git repository` value to `Yes` to sync the category and connections to your git repository. +This will add all syncable connections in that category to the git repository. +The sync settings for a category are inherited by default from its parent if not explicitly set. ### Local connections are not synced