|
11 | 11 | <p align="center">
|
12 | 12 | <a href="https://github.com/G4brym/R2-Explorer/commits/main" target="_blank">
|
13 | 13 | <img src="https://img.shields.io/github/commit-activity/m/G4brym/R2-Explorer?label=Commits&style=social" alt="R2-Explorer Commits">
|
14 |
| - </a> |
| 14 | + </a> |
15 | 15 | <a href="https://github.com/G4brym/R2-Explorer/issues" target="_blank">
|
16 | 16 | <img src="https://img.shields.io/github/issues/G4brym/R2-Explorer?style=social" alt="Issues">
|
17 |
| - </a> |
| 17 | + </a> |
18 | 18 | <a href="https://github.com/G4brym/R2-Explorer/blob/main/LICENSE" target="_blank">
|
19 | 19 | <img src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=social" alt="Software License">
|
20 |
| - </a> |
| 20 | + </a> |
21 | 21 | </p>
|
22 | 22 |
|
23 |
| -<hr /> |
| 23 | +# R2-Explorer |
| 24 | + |
| 25 | +R2-Explorer brings a familiar Google Drive-like interface to your Cloudflare R2 storage buckets, making file management simple and intuitive. |
| 26 | + |
| 27 | +## Quick Links |
| 28 | + |
| 29 | +- 📚 **Documentation**: [r2explorer.dev](https://r2explorer.dev) |
| 30 | +- 🎮 **Live Demo**: [demo.r2explorer.dev](https://demo.r2explorer.dev) |
| 31 | +- 💻 **Source Code**: [github.com/G4brym/R2-Explorer](https://github.com/G4brym/R2-Explorer) |
| 32 | + |
| 33 | +Available in multiple languages: |
| 34 | +[English](https://r2explorer.dev) | |
| 35 | +[Español](https://r2explorer-dev.translate.goog/?_x_tr_sl=en&_x_tr_tl=es) | |
| 36 | +[Português](https://r2explorer-dev.translate.goog/?_x_tr_sl=en&_x_tr_tl=pt-PT) | |
| 37 | +[Français](https://r2explorer-dev.translate.goog/?_x_tr_sl=en&_x_tr_tl=fr) |
| 38 | + |
| 39 | +## Overview |
| 40 | + |
| 41 | +R2-Explorer transforms your Cloudflare R2 storage experience with a modern, user-friendly interface. It provides powerful file management capabilities while maintaining enterprise-grade security through Cloudflare's infrastructure. |
| 42 | + |
| 43 | +## Key Features |
| 44 | + |
| 45 | +- **🔒 Security** |
| 46 | + - Basic Authentication support |
| 47 | + - Cloudflare Access integration |
| 48 | + - Self-hosted on your Cloudflare account |
| 49 | + |
| 50 | +- **📁 File Management** |
| 51 | + - Drag-and-drop file upload |
| 52 | + - Folder creation and organization |
| 53 | + - Multi-part upload for large files |
| 54 | + - Right-click context menu for advanced options |
| 55 | + - HTTP/Custom metadata editing |
24 | 56 |
|
25 |
| -**Documentation**: <a href="https://r2explorer.dev/">r2explorer.dev</a> |
| 57 | +- **👀 File Handling** |
| 58 | + - In-browser file preview |
| 59 | + - PDF documents |
| 60 | + - Images |
| 61 | + - Text files |
| 62 | + - Markdown |
| 63 | + - CSV |
| 64 | + - Logpush files |
| 65 | + - In-browser file editing |
| 66 | + - Folder upload support |
| 67 | + |
| 68 | +- **📧 Email Integration** |
| 69 | + - Receive and process emails via Cloudflare Email Routing |
| 70 | + - View email attachments directly in the interface |
26 | 71 |
|
27 |
| -**Demo**: <a href="https://demo.r2explorer.dev/">demo.r2explorer.dev</a> |
| 72 | +## Installation Methods |
28 | 73 |
|
29 |
| -**Source Code**: <a href="https://github.com/G4brym/R2-Explorer/">github.com/G4brym/R2-Explorer</a> |
| 74 | +Choose the method that best suits your needs: |
30 | 75 |
|
31 |
| -<hr /> |
| 76 | +1. **GitHub Action (Recommended)** |
| 77 | + ```bash |
| 78 | + # Follow the guide at: |
| 79 | + https://r2explorer.dev/getting-started/creating-a-new-project/#1st-method-github-action-recommended |
| 80 | + ``` |
32 | 81 |
|
33 |
| -Read this in other languages: [Español](https://r2explorer-dev.translate.goog/?_x_tr_sl=en&_x_tr_tl=es&_x_tr_hl=es&_x_tr_pto=wapp), |
34 |
| -[Português](https://r2explorer-dev.translate.goog/?_x_tr_sl=en&_x_tr_tl=pt-PT&_x_tr_hl=pt-PT&_x_tr_pto=wapp), |
35 |
| -[Français](https://r2explorer-dev.translate.goog/?_x_tr_sl=en&_x_tr_tl=fr&_x_tr_hl=fr&_x_tr_pto=wapp) |
| 82 | +2. **Cloudflare CLI** |
| 83 | + ```bash |
| 84 | + # Follow the guide at: |
| 85 | + https://r2explorer.dev/getting-started/creating-a-new-project/#2nd-method-create-cloudflare |
| 86 | + ``` |
36 | 87 |
|
37 |
| -## Features |
| 88 | +3. **Template Repository** |
| 89 | + ```bash |
| 90 | + # Use our template at: |
| 91 | + https://github.com/G4brym/R2-Explorer/tree/main/template |
| 92 | + ``` |
38 | 93 |
|
39 |
| -- Self-hosted/Deployed on your own Cloudflare Account |
40 |
| -- [Receive and read emails](https://r2explorer.dev/guides/setup-email-explorer/) (via Cloudflare Email Routing) |
41 |
| -- Security: |
42 |
| - - [Basic Auth](https://r2explorer.dev/getting-started/security/#basic-auth) |
43 |
| - - [Cloudflare Access](https://r2explorer.dev/getting-started/security/#authenticating-with-cloudflare-access) |
44 |
| -- Managing files: |
45 |
| - - In-browser File preview (pdf, image, txt, markdown, csv, logpush...) |
46 |
| - - In-browser File editing |
47 |
| - - Drag-and-Drop upload |
48 |
| - - Upload files or folders with files |
49 |
| - - Multipart upload for big files |
50 |
| - - HTTP/Custom metadata edit |
51 |
| -- Organization: |
52 |
| - - Create folders |
53 |
| - - Upload/Rename/Download/Delete files |
54 |
| - - Right click in file for extra options |
| 94 | +For detailed instructions on maintaining and updating your installation, visit our [update guide](https://r2explorer.dev/getting-started/updating-your-project/). |
55 | 95 |
|
56 |
| -## Installation |
| 96 | +## Roadmap |
57 | 97 |
|
58 |
| -1. Method: [Github Action](https://r2explorer.dev/getting-started/creating-a-new-project/#1st-method-github-action-recommended) |
59 |
| -2. Method: [Create Cloudflare CLI](https://r2explorer.dev/getting-started/creating-a-new-project/#2nd-method-create-cloudflare) |
60 |
| -3. Method: [Template](https://github.com/G4brym/R2-Explorer/tree/main/template) |
| 98 | +We're actively working on these exciting features: |
61 | 99 |
|
62 |
| -Learn more about keeping your instance updated in the [Updating your project docs](https://r2explorer.dev/getting-started/updating-your-project/). |
| 100 | +- **File Management** |
| 101 | + - Support for bucket names with spaces |
| 102 | + - File search functionality |
| 103 | + - Folder renaming capability |
| 104 | + - Image thumbnails generation |
| 105 | + |
| 106 | +- **AI Integration** |
| 107 | + - Object detection using workers-ai |
| 108 | + |
| 109 | +- **User Experience** |
| 110 | + - Enhanced timestamp tooltips |
| 111 | + - Email response capabilities |
| 112 | + - Advanced file type-specific editing |
| 113 | + |
| 114 | +## Known Issues |
63 | 115 |
|
64 |
| -## Coming soon |
| 116 | +- When using basic authentication, email inline images and assets don't load properly |
| 117 | +- Additional issues can be found and reported on our [GitHub Issues](https://github.com/G4brym/R2-Explorer/issues) page |
65 | 118 |
|
66 |
| -- allow bucket names with spaces |
67 |
| -- Search files |
68 |
| -- Rename folders |
69 |
| -- Image thumbnail's ? |
70 |
| -- Object detection on images using workers-ai ? |
71 |
| -- Tooltip when hovering a file with absolute time in "x days time ago" format |
72 |
| -- support for responding to emails |
73 |
| -- More advanced file editing with more validations per file type |
| 119 | +## Contributing |
74 | 120 |
|
75 |
| -## Known issues |
| 121 | +We welcome contributions! Whether it's bug fixes, new features, or documentation improvements, please feel free to: |
76 | 122 |
|
77 |
| -- Email inline images and assets don't load when using basic auth |
| 123 | +1. Fork the repository |
| 124 | +2. Create a feature branch |
| 125 | +3. Submit a Pull Request |
| 126 | + |
| 127 | +## Support |
| 128 | + |
| 129 | +- 📚 Documentation: [r2explorer.dev](https://r2explorer.dev) |
| 130 | +- 🐛 Issue Tracker: [GitHub Issues](https://github.com/G4brym/R2-Explorer/issues) |
| 131 | +- 💬 Discussions: [GitHub Discussions](https://github.com/G4brym/R2-Explorer/discussions) |
| 132 | + |
| 133 | +## License |
| 134 | + |
| 135 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
0 commit comments