167 lines
7.9 KiB
Markdown
167 lines
7.9 KiB
Markdown
# XPipe Vault (Keep this repository private!)
|
|
|
|
This repository contains all connection information that is designated to be shared.
|
|
|
|
You can sync with this repository in all XPipe application instances the same way, every change you make in one instance will be reflected in the repository.
|
|
|
|
## Category list
|
|
|
|
- **Connections**
|
|
- [**Proxmox Kladow**](categories/d50cc68a-3f92-42e8-b595-adfef1189d0b)
|
|
- [**VM**](categories/d0b3e32d-0e90-4484-a0ef-6af941a6dda7)
|
|
- [**Hosts**](categories/548c3618-9d59-4626-bc01-c24c3981a5a3)
|
|
- [**Container**](categories/2ebe169e-536e-4fd2-8e78-724996990fcc)
|
|
- [**Proxmox Hetzner**](categories/93b3c4d3-0549-45a4-a257-01c50efdcd0a)
|
|
- [**VM**](categories/fa303626-ee14-4bc2-b054-fb63b6bb1149)
|
|
- [**Hosts**](categories/62e4a26d-ad45-4a8f-a8b4-e63866fd2546)
|
|
- [**Container**](categories/0b2c0094-af5e-4002-8ab5-c4accf4f110e)
|
|
- [**local**](categories/86013773-4fa9-4b5e-96ad-4ac3dc8e8412)
|
|
- [**Default**](categories/97458c07-75c0-4f9d-a06e-92d8cdf67c40)
|
|
- [**Boot**](categories/a2617d04-fd39-4a6b-9e53-c9abfa46ab0d)
|
|
- **Scripts**
|
|
- [**Custom**](categories/d3496db5-b709-41f9-abc0-ee0a660fbab9)
|
|
|
|
## Connection list
|
|
|
|
**All connections / Proxmox Kladow**
|
|
|
|
empty
|
|
|
|
**All connections / Proxmox Kladow / VM**
|
|
|
|
- [**Univention fileserver archiv**](stores/6c706dfa-a3af-4a39-8d46-76c2e81e0c2c)
|
|
- [**Univention fileserver laufend**](stores/3965987a-d040-4067-a424-96fef0acd4f6)
|
|
- [**Univention PDC02**](stores/f4456d84-018b-44c7-a8ac-a9b7d1a3a960)
|
|
|
|
**All connections / Proxmox Kladow / Hosts**
|
|
|
|
- [**Proxmox Kladow Backup**](stores/8bcb2816-4273-4b84-a9aa-9788a412c633)
|
|
- [**Proxmox Kladow main**](stores/42090d28-ac8f-47f4-83b5-deb9f24cb8df)
|
|
- [**Proxmox Kladow PBS02**](stores/b316ff0d-248d-4386-abad-9a2a9ec226cb)
|
|
|
|
**All connections / Proxmox Kladow / Container**
|
|
|
|
- [**pihole**](stores/543fd734-85a0-45f3-b9a5-f47c775ea94b)
|
|
- [**wireguard**](stores/765f9104-a04c-424a-99e7-4e585b4334d7)
|
|
|
|
**All connections / Proxmox Hetzner**
|
|
|
|
empty
|
|
|
|
**All connections / Proxmox Hetzner / VM**
|
|
|
|
- [**Terminalserver 174**](stores/205bef19-12ff-47ce-9870-0ccf4dfde314)
|
|
|
|
**All connections / Proxmox Hetzner / Hosts**
|
|
|
|
- [**Proxmox Hetzner**](stores/ad0a88c2-b577-490e-8d5b-693e9a0da790)
|
|
- [**Proxmox Hetzner PBS**](stores/488ac586-e7d0-4606-99b3-71893e996449)
|
|
|
|
**All connections / Proxmox Hetzner / Container**
|
|
|
|
- [**docker-baikal**](stores/1eec68c5-8b44-4dc1-9538-be321f0e5d1a)
|
|
- [**Docker containers**](stores/39ae0714-8d26-4392-bacc-a27172f46980)
|
|
- [**default**](stores/5689dfdd-5eb0-4638-a989-f39ccf807aca)
|
|
- [**Shell environments**](stores/83649c48-0a9f-3ed6-99dd-264cae2123f5)
|
|
- [**bash**](stores/c0832cb6-3b64-44da-b936-e0b09e9b4f46)
|
|
- [**dash**](stores/69f3d33e-e3cc-4d6e-9333-3d89575e3e1e)
|
|
- [**docker-proxy**](stores/877b6c0b-6451-4058-9d08-64825cbdf8bc)
|
|
- [**Docker containers**](stores/a81caf51-eb7c-4e70-9a22-273e3ced63f8)
|
|
- [**default**](stores/92375336-dd3e-4869-b31a-f8d89326aa59)
|
|
- [**Shell environments**](stores/526b6bf0-ee75-3287-a027-6b9d8a41ba28)
|
|
- [**bash**](stores/33ec1643-d41b-4155-92b0-c763346d6af6)
|
|
- [**dash**](stores/74e48ebb-a46d-48ee-8f74-ce40ab939c4f)
|
|
- [**dolibarr**](stores/435e8beb-3eee-42b3-b0dc-730bd3ffdc90)
|
|
- [**ecomailz**](stores/a6f96658-d009-475c-8b34-1739887b147a)
|
|
- [**Shell environments**](stores/65353629-b850-3e01-8632-1ee81be3cc83)
|
|
- [**bash**](stores/52203dda-11b7-4c0b-8d19-20fd4c93a24f)
|
|
- [**dash**](stores/5a252c89-a1ff-4c89-83ac-d1a12fa962fd)
|
|
- [**gitea**](stores/a28016a2-bedd-4317-9577-c3b13459a841)
|
|
- [**Shell environments**](stores/5abe7816-b2f6-3023-bb73-d5d0e5e9bc72)
|
|
- [**bash**](stores/341ccf7f-08c2-47b8-9e8e-2f5f47ce4295)
|
|
- [**dash**](stores/30da6137-4a13-4289-86b8-8b2e6d9514f4)
|
|
- [**Influxdb**](stores/e3b9d53e-3b70-4dd2-81d5-b8be0499e10b)
|
|
- [**Shell environments**](stores/10b9fbae-fd5d-368a-bda2-041359b593f5)
|
|
- [**bash**](stores/5b0a56c7-2212-4d87-bd05-f9d1d26262b4)
|
|
- [**dash**](stores/f32b6d78-22d7-485c-833e-e69b65cd72d6)
|
|
- [**Lizenzserver**](stores/1825b2c2-fb6e-46a2-b43d-8bae357e34ea)
|
|
- [**Shell environments**](stores/3c4054b0-b184-3397-97f5-dbf444cf416c)
|
|
- [**bash**](stores/dbd7adae-2a5f-4c24-b801-73d75ba537c8)
|
|
- [**dash**](stores/318e71d7-ab7a-4dda-9b51-998569745a7f)
|
|
|
|
**All connections / local**
|
|
|
|
empty
|
|
|
|
**All connections / Default**
|
|
|
|
empty
|
|
|
|
**All connections / Boot**
|
|
|
|
empty
|
|
|
|
**All scripts / Custom**
|
|
|
|
- [**My scripts**](stores/a9945ad2-db61-4304-97d7-5dc4330691a7)
|
|
|
|
|
|
## Secret encryption
|
|
|
|
You have the option to fetch any sensitive information like passwords from outside sources like password managers or enter them at connection time through a prompt window. In that case, XPipe doesn't have to store any secrets itself.
|
|
|
|
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)
|
|
|
|
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.
|
|
|
|
## Cloning the repository on other systems
|
|
|
|
Nowadays, most providers require a personal access token (PAT) to authenticate from the command-line instead of traditional passwords.
|
|
You can find common (PAT) pages here:
|
|
- **GitHub**: [Personal access tokens (classic)](https://github.com/settings/tokens)
|
|
- **GitLab**: [Personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)
|
|
- **BitBucket**: [Personal access token](https://support.atlassian.com/bitbucket-cloud/docs/access-tokens/)
|
|
- **Gitea**: `Settings -> Applications -> Manage Access Tokens section`
|
|
Set the token permission for repository to Read and Write. The rest of the token permissions can be set as Read.
|
|
|
|
Even if your git client prompts you for a password, you should enter your token unless your provider still uses passwords.
|
|
|
|
If you don't want to enter your credentials every time, you can use any git credentials manager for that.
|
|
For more information, see for example:
|
|
- https://git-scm.com/doc/credential-helpers
|
|
- https://docs.github.com/en/get-started/getting-started-with-git/caching-your-github-credentials-in-git
|
|
|
|
Some modern git clients also take care of storing credentials automatically.
|
|
|
|
## Troubleshooting
|
|
|
|
### Adding categories 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)
|
|
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.
|
|
|
|
### 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.
|