Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

unclear message if sftp unsupported due to paramiko missing #84

Closed
ThomasWaldmann opened this issue Dec 2, 2024 · 2 comments
Closed
Labels
documentation Improvements or additions to documentation

Comments

@ThomasWaldmann
Copy link
Member

ThomasWaldmann commented Dec 2, 2024

The "Invalid Backend Storage URL" exception msg can be misleading, e.g. if paramiko is not present, sftp: URLs are just unsupported (even for valid, well formed URLs).

See: borgbackup/borg#8574

@ThomasWaldmann
Copy link
Member Author

ThomasWaldmann commented Dec 2, 2024

Improved exception message to include "... or unsupported ...".

The solution for sftp: is usually to use: pip install 'borgstore[sftp]'

Without the [sftp] part, paramiko won't be pulled in as a requirement and without paramiko, borgstore won't have support for sftp:// URLs.

Please note that using sftp protocol is also possible via a rclone:... store using a correctly set up rclone remote for sftp.

@ThomasWaldmann ThomasWaldmann added the documentation Improvements or additions to documentation label Dec 2, 2024
@ThomasWaldmann
Copy link
Member Author

It's also already mentioned in the install section of the readme

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant