diff --git a/doc/book/src/SUMMARY.md b/doc/book/src/SUMMARY.md index d9b76e96..9d831643 100644 --- a/doc/book/src/SUMMARY.md +++ b/doc/book/src/SUMMARY.md @@ -14,10 +14,10 @@ - [Recovering from failures](./cookbook/recovering.md) - [Integrations](./connect/index.md) + - [Browsing tools (awscli, mc...)](./connect/cli.md) - [Apps (Nextcloud, Peertube...)](./connect/apps.md) - [Websites (Hugo, Jekyll, Publii...)](./connect/websites.md) - [Repositories (Docker, Nix, Git...)](./connect/repositories.md) - - [CLI tools (rclone, awscli, mc...)](./connect/cli.md) - [Backups (restic, duplicity...)](./connect/backup.md) - [Your code (PHP, JS, Go...)](./connect/code.md) - [FUSE (s3fs, goofys, s3backer...)](./connect/fs.md) diff --git a/doc/book/src/connect/cli.md b/doc/book/src/connect/cli.md index e5c4a495..6d158eaf 100644 --- a/doc/book/src/connect/cli.md +++ b/doc/book/src/connect/cli.md @@ -1,18 +1,19 @@ -# CLI tools +# Browsing tools -CLI tools allow you to query the S3 API without too many abstractions. +Browsing tools allow you to query the S3 API without too many abstractions. These tools are particularly suitable for debug, backups, website deployments or any scripted task that need to handle data. | Name | Status | Note | |------|--------|------| -| [Minio client](#minio-client-recommended) | ✅ | | -| [AWS CLI](#aws-cli) | ✅ | | +| [Minio client](#minio-client-recommended) | ✅ | Recommended | +| [AWS CLI](#aws-cli) | ✅ | Recommended | | [rclone](#rclone) | ✅ | | | [s3cmd](#s3cmd) | ✅ | | | [(Cyber)duck](#cyberduck--duck) | ✅ | | +| [WinSCP (libs3)](#winscp) | ✅ | No instructions yet | -## Minio client (recommended) +## Minio client Use the following command to set an "alias", i.e. define a new S3 server to be used by the Minio client: @@ -269,3 +270,8 @@ duck --upload /tmp/object.txt garage:/my-files/another-object.txt # Delete an object duck --delete garage:/my-files/an-object.txt ``` + +## WinSCP (libs3) + +*No instruction yet. You can find ones in french [in our wiki](https://wiki.deuxfleurs.fr/fr/Guide/Garage/WinSCP).* +