Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs and update README.md #75

Merged
merged 1 commit into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 50 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,64 +1,67 @@
[![Commit rate](https://img.shields.io/github/commit-activity/m/G4brym/R2-Explorer?label=Commits&style=social)](https://github.com/G4brym/R2-Explorer/commits/main) [![Issues](https://img.shields.io/github/issues/G4brym/R2-Explorer?style=social)](https://github.com/G4brym/R2-Explorer/issues) [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=social)](LICENSE)

Read this in other languages: [Español](READMEes.md), [Português](READMEpt.md), [Français](READMEfr.md)

# R2-Explorer
<div align="center">
<a href="https://r2explorer.dev/">
<img src="https://raw.githubusercontent.com/G4brym/R2-explorer/refs/heads/main/docs/pages/assets/r2-explorer-logo.png" width="500" height="auto" alt="R2-Explorer"/>
</a>
</div>

<p align="center">
<em>A Google Drive Interface for your Cloudflare R2 Buckets!</em>
</p>

<p>
This project is deployed/self-hosted in your own Cloudflare Account as a Worker, and no credential/token is required to
start using it.
<p align="center">
<a href="https://github.com/G4brym/R2-Explorer/commits/main" target="_blank">
<img src="https://img.shields.io/github/commit-activity/m/G4brym/R2-Explorer?label=Commits&style=social" alt="R2-Explorer Commits">
</a>
<a href="https://github.com/G4brym/R2-Explorer/issues" target="_blank">
<img src="https://img.shields.io/github/issues/G4brym/R2-Explorer?style=social" alt="Issues">
</a>
<a href="https://github.com/G4brym/R2-Explorer/blob/main/LICENSE" target="_blank">
<img src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=social" alt="Software License">
</a>
</p>

---
<hr />

**Documentation**: <a href="https://r2explorer.dev" target="_blank">https://r2explorer.dev</a>
**Documentation**: <a href="https://r2explorer.dev/">r2explorer.dev</a>

**Live Demo**: <a href="https://demo.r2explorer.dev" target="_blank">https://demo.r2explorer.dev</a>

---

## Features
**Demo**: <a href="https://demo.r2explorer.dev/">demo.r2explorer.dev</a>

- PWA support (install this app on your phone)
- [Email Explorer](https://r2explorer.dev/guides/setup-email-explorer/) (using Cloudflare Email Routing)
- [Basic Auth](https://r2explorer.dev/getting-started/security/#basic-auth)
- [Cloudflare Access Authentication](https://r2explorer.dev/getting-started/security/)
- Very quick bucket/folder navigation
- pdf, image, txt, markdown, csv, etc in-browser preview
- Drag-and-Drop upload
- Multiple files and folder uploads
- Create folders
- Upload/Rename/Download/Delete files
- Right click in file for extra options
- Multipart upload for big files
- File editing
**Source Code**: <a href="https://github.com/G4brym/R2-Explorer/">github.com/G4brym/R2-Explorer</a>

## Getting Started
<hr />

Run this command to get an example project setup
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),
[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),
[Français](https://r2explorer-dev.translate.goog/?_x_tr_sl=en&_x_tr_tl=fr&_x_tr_hl=fr&_x_tr_pto=wapp)

```bash
npm create cloudflare@latest r2-explorer -- --template "G4brym/R2-Explorer/template"
```

## Upgrading your installation

In order to update to the latest version you just need to install the latest r2-explorer package from npm and re-deploy
your application

```bash
npm install r2-explorer@latest --save
```

```bash
wrangler publish
```
## Features

## TODO
- Self-hosted/Deployed on your own Cloudflare Account
- [Receive and read emails](https://r2explorer.dev/guides/setup-email-explorer/) (via Cloudflare Email Routing)
- Security:
- [Basic Auth](https://r2explorer.dev/getting-started/security/#basic-auth)
- [Cloudflare Access](https://r2explorer.dev/getting-started/security/#authenticating-with-cloudflare-access)
- Managing files:
- In-browser File preview (pdf, image, txt, markdown, csv, logpush...)
- In-browser File editing
- Drag-and-Drop upload
- Upload files or folders with files
- Multipart upload for big files
- HTTP/Custom metadata edit
- Organization:
- Create folders
- Upload/Rename/Download/Delete files
- Right click in file for extra options

## Installation

1. Method: [Github Action](https://r2explorer.dev/getting-started/creating-a-new-project/#1st-method-github-action-recommended)
2. Method: [Create Cloudflare CLI](https://r2explorer.dev/getting-started/creating-a-new-project/#2nd-method-create-cloudflare)
3. Method: [Template](https://github.com/G4brym/R2-Explorer/tree/main/template)

Learn more about keeping your instance updated in the [Updating your project docs](https://r2explorer.dev/getting-started/updating-your-project/).

## Coming soon

- allow bucket names with spaces
- Search files
Expand Down
65 changes: 0 additions & 65 deletions READMEes.md

This file was deleted.

65 changes: 0 additions & 65 deletions READMEfr.md

This file was deleted.

64 changes: 0 additions & 64 deletions READMEpt.md

This file was deleted.

4 changes: 4 additions & 0 deletions docs/_redirects
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/getting-started /getting-started/creating-a-new-project 302
/getting-started/ /getting-started/creating-a-new-project 302
/getting-started/setup-using-github-actions /getting-started/creating-a-new-project 302
/getting-started/setup-using-github-actions/ /getting-started/creating-a-new-project 302
Loading
Loading