diff --git a/README.md b/README.md index e124f33..d06e2f6 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,8 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a ### S3 +- Tutorials / Examples: + - [MinIO](./docs/remote_services/s3_minio/README.md) - Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault. - About CORS: - If you are using Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, you can skip this CORS part. diff --git a/docs/remote_services/s3_minio/README.md b/docs/remote_services/s3_minio/README.md new file mode 100644 index 0000000..b188dc3 --- /dev/null +++ b/docs/remote_services/s3_minio/README.md @@ -0,0 +1,19 @@ +# MinIO + +## Links + + + +## Steps + +1. Configure your minio instance and get an account. +2. Create an Access Key (during the creation, you will also get the auto-generated secret key). + ![](./minio_access_key.png) +3. Check or set the region. + ![](./minio_region.png) +4. Create a bucket. + ![](./minio_create_bucket.png) +5. In remotely-save setting page, input the address / bucket / access key / secret key. **Usually minio instances may need "S3 URL style"="Path Style".** Enable "Bypass CORS", because usually that's what you want. + ![](./minio_rs_settings.png) +6. Sync! + ![](./minio_sync_success.png) diff --git a/docs/remote_services/s3_minio/minio_access_key.png b/docs/remote_services/s3_minio/minio_access_key.png new file mode 100644 index 0000000..5ecfdef --- /dev/null +++ b/docs/remote_services/s3_minio/minio_access_key.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c384ec32a43fcac1e63dbc81d4fbb7fbfaffcd67d0f5a66104482a39475ad639 +size 323050 diff --git a/docs/remote_services/s3_minio/minio_create_bucket.png b/docs/remote_services/s3_minio/minio_create_bucket.png new file mode 100644 index 0000000..461fae9 --- /dev/null +++ b/docs/remote_services/s3_minio/minio_create_bucket.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:894a6a10b7f41754936d77a935b4a5a4ae722796fa5680c9c6d0dd53c3cdc1a2 +size 269705 diff --git a/docs/remote_services/s3_minio/minio_region.png b/docs/remote_services/s3_minio/minio_region.png new file mode 100644 index 0000000..80575be --- /dev/null +++ b/docs/remote_services/s3_minio/minio_region.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bfcc526281d2c6a9f1261f489603f3dd768f8b94f099a1b26649fa37c9318575 +size 315030 diff --git a/docs/remote_services/s3_minio/minio_rs_settings.png b/docs/remote_services/s3_minio/minio_rs_settings.png new file mode 100644 index 0000000..2d9af46 --- /dev/null +++ b/docs/remote_services/s3_minio/minio_rs_settings.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:83615a6c2fbf7ff74679b480d29d222db8835bc067aee33a646e4b8d500c3aca +size 467575 diff --git a/docs/remote_services/s3_minio/minio_sync_success.png b/docs/remote_services/s3_minio/minio_sync_success.png new file mode 100644 index 0000000..2bd664e --- /dev/null +++ b/docs/remote_services/s3_minio/minio_sync_success.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fd1bb9a6e285a1e63b545d714ca269eb714e980a5177392b967556f1f1754afe +size 147218