Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
qoomon authored Jul 5, 2024
1 parent cb48419 commit 9b7e2c5
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ Single HTML file to browse AWS S3 buckets
## Installation

#### Self-Hosted
<details>
<summary>Click me</summary>

* Just download [`index.html`](index.html) and upload it to your bucket.
* Adjust [config](index.html#L8-L37) within `index.html` if needed, e.g.
```js
Expand Down Expand Up @@ -107,8 +110,13 @@ Single HTML file to browse AWS S3 buckets
]
```
* Open `<YOUR BUCKET URL>/index.html` in your browser.


</details>

#### Hosted
<details>
<summary>Click me</summary>

* ##### ⚠️ Ensure Bucket Permissions
* see [Self-Hosted](#self-hosted)
* ##### ⚠️ Ensure Bucket CORS
Expand All @@ -117,8 +125,12 @@ Single HTML file to browse AWS S3 buckets
* `${INDEX_FILE_LOCATION}?bucket=${S3_BUCKET_URL}`
* e.g. [`https://qoomon.github.io/aws-s3-bucket-browser/index.html?bucket=https://s3.eu-west-1.amazonaws.com/data.openspending.org`](https://qoomon.github.io/aws-s3-bucket-browser/index.html?bucket=https://s3.eu-west-1.amazonaws.com/data.openspending.org)

</details>

### CloudFront Setup
<details>
<summary>Click me</summary>

If you use CloudFront in upfront of your S3 bucket ensure following CloudFront settings.
- Allowed/Cached HTTP Methods: `GET`, `HEAD`, `OPTIONS`
- Cached Based on Selected Headers: `Whitelist`
Expand All @@ -127,7 +139,12 @@ If you use CloudFront in upfront of your S3 bucket ensure following CloudFront s
- `Origin`
- Query String Forwarding and Caching: `Forward all`

</details>

### IBM Cloud Object Storage Setup
<details>
<summary>Click me</summary>

IBM Cloud Object storage only supports virtual host-style addressing, i.e. `https://<bucket-name>s3-web.<region>.cloud-object-storage.appdomain.cloud/` for static website hosting. Otherwise follow the instructions
in this [tutorial](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-static-website-tutorial) to configure your bucket. In addition, you may need to [configure CORS](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-curl#curl-new-cors) for your bucket.

Expand All @@ -140,3 +157,5 @@ in this [tutorial](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-o
</CORSRule>
</CORSConfiguration>
```

</details>

0 comments on commit 9b7e2c5

Please sign in to comment.