Betterflare Documentation
Welcome to the Betterflare documentation. Learn how to use Betterflare to manage your Cloudflare R2 storage.
Installation
Get Betterflare up and running in your environment.
Use Our Hosted Version
The easiest way to get started with Betterflare is to use our hosted version. No installation required!
1. Sign up for a free account at betterflare.io
2. Connect your Cloudflare account
3. Start managing your R2 storage
Quick Start
Get up and running with Betterflare in minutes.
1. Connect Your Cloudflare Account
First, you'll need to connect Betterflare to your Cloudflare account using an API token.
1. Log in to your Cloudflare dashboard
2. Navigate to My Profile > API Tokens
3. Create a new token with the following permissions:
- Account.R2: Read
- Account.R2 Storage: Edit
2. Configure Betterflare
Once you have your API token, you can configure Betterflare.
# Set your Cloudflare API token
export CLOUDFLARE_API_TOKEN=your_token
# Start Betterflare
betterflare startAlternatively, you can use the web interface to enter your API token.
3. Start Managing Your R2 Storage
Once connected, you'll see all your R2 buckets and can start managing them.
• Create new buckets
• Upload and organize files
• Configure access permissions
• Generate shareable links
API Reference
Integrate Betterflare with your applications using our API.
Authentication
All API requests require authentication using an API token.
curl -X GET https://api.betterflare.io/v1/buckets \
-H "Authorization: Bearer YOUR_API_TOKEN"Endpoints
Here are some of the key endpoints available in the Betterflare API.
List Buckets
GET /v1/buckets
Create Bucket
POST /v1/buckets
List Objects
GET /v1/buckets/{bucket_name}/objects
Upload Object
POST /v1/buckets/{bucket_name}/objects
Generate Presigned URL
POST /v1/buckets/{bucket_name}/objects/{object_key}/presign
CLI Reference
Manage your R2 storage from the command line with the Betterflare CLI.
Installation
npm install -g @betterflare/cliCommands
Authentication
betterflare loginList Buckets
betterflare buckets listUpload File
betterflare upload my-bucket ./local-file.jpgDownload File
betterflare download my-bucket remote-file.jpg ./local-file.jpgExamples
Explore examples and use cases for Betterflare.
CI/CD Integration
Integrate Betterflare with your CI/CD pipeline for automated deployments.
View ExampleCustom Domain Setup
Configure a custom domain to serve content directly from your R2 bucket.
View ExampleCommunity & Support
Get help and connect with the Betterflare community.