Skip to content

Commit 9b7e2c5

Browse files
authored
Update README.md
1 parent cb48419 commit 9b7e2c5

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ Single HTML file to browse AWS S3 buckets
1414
## Installation
1515

1616
#### Self-Hosted
17+
<details>
18+
<summary>Click me</summary>
19+
1720
* Just download [`index.html`](index.html) and upload it to your bucket.
1821
* Adjust [config](index.html#L8-L37) within `index.html` if needed, e.g.
1922
```js
@@ -107,8 +110,13 @@ Single HTML file to browse AWS S3 buckets
107110
]
108111
```
109112
* Open `<YOUR BUCKET URL>/index.html` in your browser.
110-
113+
114+
</details>
115+
111116
#### Hosted
117+
<details>
118+
<summary>Click me</summary>
119+
112120
* ##### ⚠️ Ensure Bucket Permissions
113121
* see [Self-Hosted](#self-hosted)
114122
* ##### ⚠️ Ensure Bucket CORS
@@ -117,8 +125,12 @@ Single HTML file to browse AWS S3 buckets
117125
* `${INDEX_FILE_LOCATION}?bucket=${S3_BUCKET_URL}`
118126
* 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)
119127

128+
</details>
120129

121130
### CloudFront Setup
131+
<details>
132+
<summary>Click me</summary>
133+
122134
If you use CloudFront in upfront of your S3 bucket ensure following CloudFront settings.
123135
- Allowed/Cached HTTP Methods: `GET`, `HEAD`, `OPTIONS`
124136
- Cached Based on Selected Headers: `Whitelist`
@@ -127,7 +139,12 @@ If you use CloudFront in upfront of your S3 bucket ensure following CloudFront s
127139
- `Origin`
128140
- Query String Forwarding and Caching: `Forward all`
129141

142+
</details>
143+
130144
### IBM Cloud Object Storage Setup
145+
<details>
146+
<summary>Click me</summary>
147+
131148
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
132149
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.
133150

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

0 commit comments

Comments
 (0)