Update README.md
This commit is contained in:
parent
d3ddff9d54
commit
3224f74ecc
25
README.md
25
README.md
|
|
@ -20,6 +20,8 @@ You can sync with this repository in all XPipe application instances the same wa
|
|||
- [**Boot**](categories/a2617d04-fd39-4a6b-9e53-c9abfa46ab0d)
|
||||
- **Scripts**
|
||||
- [**Custom**](categories/d3496db5-b709-41f9-abc0-ee0a660fbab9)
|
||||
- **Identities**
|
||||
- [**Synced**](categories/69aa5040-28dc-451e-b4ff-1192ce5e1e3c)
|
||||
|
||||
## Connection list
|
||||
|
||||
|
|
@ -123,6 +125,10 @@ empty
|
|||
|
||||
- [**My scripts**](stores/a9945ad2-db61-4304-97d7-5dc4330691a7)
|
||||
|
||||
**All identities / Synced**
|
||||
|
||||
empty
|
||||
|
||||
|
||||
## Secret encryption
|
||||
|
||||
|
|
@ -131,7 +137,7 @@ 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 master passphrase that can be set by you in the settings menu, combined with the vault key file (This option is only as secure as the password you choose)
|
||||
- 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)
|
||||
|
||||
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.
|
||||
|
|
@ -158,27 +164,16 @@ Some modern git clients also take care of storing credentials automatically.
|
|||
|
||||
## Troubleshooting
|
||||
|
||||
### Adding categories to the repository
|
||||
### Adding connections to the repository
|
||||
|
||||
By default, no categories are set to shared so that you have explicit control on what connections to commit.
|
||||
|
||||
To have your connections of a category put inside your git repository,
|
||||
you need to click on the `⚙️` icon (when hovering over the category)
|
||||
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 to the git repository.
|
||||
This will add all shareable connections in that category to the git repository.
|
||||
|
||||
### Local connections are not synced
|
||||
|
||||
Any connection located under the local machine can not be shared as it refers to connections and data that are only available on the local system.
|
||||
|
||||
Certain connections that are based on a local file, for example SSH configs, can be shared via git if the underlying data, in this case the file, have been added to the git repository as well.
|
||||
|
||||
### Other issues
|
||||
|
||||
If you encounter any other issues, you can try interacting with the cloned repository manually.
|
||||
You can find it at `%USERPROFILE%\.xpipe\storage\` or `~/.xpipe/storage/`.
|
||||
XPipe will call your installed git client, so any potential issues with your local git client also transfer to XPipe.
|
||||
|
||||
To understand what went wrong, you can also launch XPipe in debug mode at `Settings -> Troubleshoot -> Launch in debug mode`.
|
||||
This will tell you in detail what git commands are executed.
|
||||
|
|
|
|||
Loading…
Reference in New Issue