r2-explorer 0.2.7 → 0.2.8
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 +114 -0
- package/bin/r2-explorer.js +1 -1
- package/dist/umd/index.js +1 -1
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# R2-Explorer
|
|
2
|
+
|
|
3
|
+
A Google Drive Interface for your Cloudflare R2 Buckets!
|
|
4
|
+
|
|
5
|
+
This project is deployed/self-hosted in your own Cloudflare Account as a Worker, and no credential/token is required to start using it.
|
|
6
|
+
|
|
7
|
+
You can see an live example, in `read-only` mode, in your browser at https://r2-explorer.massadas.com/
|
|
8
|
+
|
|
9
|
+
## Features
|
|
10
|
+
|
|
11
|
+
- Very quick bucket/folder navigation
|
|
12
|
+
- pdf, image, txt, markdown, csv, etc in-browser preview
|
|
13
|
+
- Drag-and-Drop upload
|
|
14
|
+
- Create folders
|
|
15
|
+
- Rename files
|
|
16
|
+
- Download files
|
|
17
|
+
- Delete files
|
|
18
|
+
- Right click in file for extra options
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
## FAQ
|
|
22
|
+
|
|
23
|
+
Q. Is there any Authentication for r2-explorer?
|
|
24
|
+
|
|
25
|
+
A. No. If you want authenticated access, you must setup [Cloudflare Access](https://www.cloudflare.com/products/zero-trust/access/) in your account.
|
|
26
|
+
Access is free up to 50 users.
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
## Getting Started
|
|
30
|
+
|
|
31
|
+
Run this command to get an example project setup
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npx r2-explorer my-r2-explorer
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Change into the newly created directory and install the packages
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
cd my-r2-explorer
|
|
41
|
+
npm install
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Update the `wrangler.toml` with your R2 Buckets (tip: you can setup as many Buckets as your want)
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
- wrangler.toml -
|
|
48
|
+
...
|
|
49
|
+
[[r2_buckets]]
|
|
50
|
+
binding = 'my-bucket-name'
|
|
51
|
+
bucket_name = 'my-bucket-name'
|
|
52
|
+
preview_bucket_name = 'my-bucket-name'
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
If you want to be able to upload/modify your buckets, you must update the `readonly` flag in `src/index.ts` file.
|
|
56
|
+
|
|
57
|
+
After that just run publish and the project will be up and running for you and everyone you invite to use the Buckets
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
wrangler publish
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## TODO
|
|
64
|
+
|
|
65
|
+
- Integration with cloudflare access
|
|
66
|
+
- allow bucket names with spaces
|
|
67
|
+
- Search files
|
|
68
|
+
- Upload folders
|
|
69
|
+
- Rename folders
|
|
70
|
+
- Delete folders
|
|
71
|
+
- Image thumbnail's using Cloudflare workers
|
|
72
|
+
- Tooltip when hovering a file with absolute time in "x days time ago" format
|
|
73
|
+
- Upload folders with files
|
|
74
|
+
- Automatically load more files, when the bottom is reached (current limit is 1000 files)
|
|
75
|
+
- Download files bigger than 2gb with presigned url's
|
|
76
|
+
|
|
77
|
+
## Known issues
|
|
78
|
+
|
|
79
|
+
- Rename files with special characters is not possible with current [sdk issue here](https://github.com/aws/aws-sdk-js/issues/1949)
|
|
80
|
+
|
|
81
|
+
## Images
|
|
82
|
+
|
|
83
|
+
Home Page
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
Image Previewer
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
Pdf Previewer
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
New Folder
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
Uploading Files
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
### Compiles and hot-reloads for development
|
|
99
|
+
|
|
100
|
+
```
|
|
101
|
+
npm run serve
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Compiles and minifies for production
|
|
105
|
+
|
|
106
|
+
```
|
|
107
|
+
npm run build
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Lints and fixes files
|
|
111
|
+
|
|
112
|
+
```
|
|
113
|
+
npm run lint
|
|
114
|
+
```
|