r2-explorer 0.5.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -9
- package/bin/r2-explorer.js +1 -1
- package/dist/umd/index.js +231 -11
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -2,11 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
A Google Drive Interface for your Cloudflare R2 Buckets!
|
|
4
4
|
|
|
5
|
-
This project is deployed/self-hosted in your own Cloudflare Account as a Worker, and no credential/token is required to
|
|
5
|
+
This project is deployed/self-hosted in your own Cloudflare Account as a Worker, and no credential/token is required to
|
|
6
|
+
start using it.
|
|
6
7
|
|
|
7
8
|
You can see an live example, in `read-only` mode, in your browser at https://r2-explorer.massadas.com/
|
|
8
9
|
|
|
9
|
-
This project is still in development, and there are definitely going to be some weird issues sometimes, but when you
|
|
10
|
+
This project is still in development, and there are definitely going to be some weird issues sometimes, but when you
|
|
11
|
+
find something
|
|
10
12
|
please [open an new issue](https://github.com/G4brym/R2-Explorer/issues/new) for it to get solved.
|
|
11
13
|
|
|
12
14
|
## Features
|
|
@@ -21,23 +23,35 @@ please [open an new issue](https://github.com/G4brym/R2-Explorer/issues/new) for
|
|
|
21
23
|
- Delete files
|
|
22
24
|
- Right click in file for extra options
|
|
23
25
|
- Multipart upload for big files
|
|
26
|
+
- Cloudflare Access validation using jwt
|
|
27
|
+
|
|
28
|
+
## Configurations
|
|
29
|
+
|
|
30
|
+
These options are defined in the `index.js` file, in the `R2Explorer({ readonly: false, ... })`.
|
|
31
|
+
|
|
32
|
+
| Name | Type(s) | Description | Examples |
|
|
33
|
+
|--------------------|--------------------------|-----------------------------------------------------------------------|-----------------------------------------------------------|
|
|
34
|
+
| `readonly` | `boolean` or `undefined` | Controls the write access globally, default: `true` | `true` |
|
|
35
|
+
| `cors` | `boolean` or `undefined` | Enables or disables CORS access to the internal API, default: `false` | `true` |
|
|
36
|
+
| `cfAccessTeamName` | `string` or `undefined` | When set enforces Cloudflare Access in all requests | `radar` (taken from https://radar.cloudflareaccess.com/) |
|
|
24
37
|
|
|
25
38
|
|
|
26
39
|
## FAQ
|
|
27
40
|
|
|
28
41
|
Q. Is there any Authentication for r2-explorer?
|
|
29
42
|
|
|
30
|
-
A. No. If you want authenticated access, you must
|
|
43
|
+
A. No. If you want authenticated access, you must
|
|
44
|
+
setup [Cloudflare Access](https://www.cloudflare.com/products/zero-trust/access/) in your account.
|
|
31
45
|
Access is free up to 50 users.
|
|
32
46
|
|
|
33
47
|
___
|
|
34
48
|
|
|
35
49
|
Q. Can i upload files bigger than 100MB?
|
|
36
50
|
|
|
37
|
-
A. Yes! R2-Explorer now
|
|
51
|
+
A. Yes! R2-Explorer now
|
|
52
|
+
support's [Multipart Upload](https://developers.cloudflare.com/r2/data-access/workers-api/workers-multipart-usage/),
|
|
38
53
|
that splits the files you are uploading in about 95MB chunks for uploading within the Cloudflare 100MB uploading limit.
|
|
39
54
|
|
|
40
|
-
|
|
41
55
|
## Getting Started
|
|
42
56
|
|
|
43
57
|
Run this command to get an example project setup
|
|
@@ -73,7 +87,9 @@ wrangler publish
|
|
|
73
87
|
```
|
|
74
88
|
|
|
75
89
|
## Upgrading your installation
|
|
76
|
-
|
|
90
|
+
|
|
91
|
+
In order to update to the latest version you just need to install the latest r2-explorer package from npm and re-deploy
|
|
92
|
+
your application
|
|
77
93
|
|
|
78
94
|
```bash
|
|
79
95
|
npm install r2-explorer@latest --save
|
|
@@ -83,10 +99,8 @@ npm install r2-explorer@latest --save
|
|
|
83
99
|
wrangler publish
|
|
84
100
|
```
|
|
85
101
|
|
|
86
|
-
|
|
87
102
|
## TODO
|
|
88
103
|
|
|
89
|
-
- Integration with cloudflare access
|
|
90
104
|
- allow bucket names with spaces
|
|
91
105
|
- Search files
|
|
92
106
|
- Rename folders
|
|
@@ -100,7 +114,8 @@ wrangler publish
|
|
|
100
114
|
|
|
101
115
|
## Known issues
|
|
102
116
|
|
|
103
|
-
- Rename files with special characters is not possible with
|
|
117
|
+
- Rename files with special characters is not possible with
|
|
118
|
+
current [sdk issue here](https://github.com/aws/aws-sdk-js/issues/1949)
|
|
104
119
|
|
|
105
120
|
## Images
|
|
106
121
|
|