https://github.com/hbmartin/r2j2
A Cloudflare Worker that provides a secure API endpoint for logging timestamped journal entries to R2 storage.
https://github.com/hbmartin/r2j2
Last synced: 24 days ago
JSON representation
A Cloudflare Worker that provides a secure API endpoint for logging timestamped journal entries to R2 storage.
- Host: GitHub
- URL: https://github.com/hbmartin/r2j2
- Owner: hbmartin
- Created: 2025-06-25T20:32:48.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-06-25T20:39:08.000Z (3 months ago)
- Last Synced: 2025-06-25T21:33:33.529Z (3 months ago)
- Language: TypeScript
- Size: 0 Bytes
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Journal API Worker
A Cloudflare Worker that provides a secure API endpoint for logging timestamped journal entries to R2 storage.
## Setup Instructions
### 1. Create R2 Bucket
First, create an R2 bucket:
```bash
npx wrangler r2 bucket create your-bucket-name
```
### 2. Configure Environment Variables
Set the secret password for API authentication:
```bash
npx wrangler secret put SECRET_PASSWORD
```
When prompted, enter your desired password. This will be stored securely in Cloudflare's environment.
### 3. Verify Configuration
The R2 bucket binding is already configured in `wrangler.jsonc`:
```json
"r2_buckets": [
{
"binding": "JOURNAL_BUCKET",
"bucket_name": "your-bucket-name"
}
]
```
### 4. Deploy
Deploy the worker to Cloudflare:
```bash
npm run deploy
```
## Usage
### API Endpoints
#### Add Journal Entry
- **Method**: GET
- **Path**: `/`
- **Parameters**:
- `password` (required): Must match your `SECRET_PASSWORD`
- `text` (required): Journal entry text (will be URL decoded)
**Example Request:**
```bash
curl "https://your-worker.your-subdomain.workers.dev/?password=your-secret&text=Hello%20World%21"
```
#### Retrieve Journal Contents
- **Method**: GET
- **Path**: `/csv`
- **Parameters**:
- `password` (required): Must match your `SECRET_PASSWORD`
**Example Request:**
```bash
curl "https://your-worker.your-subdomain.workers.dev/csv?password=your-secret"
```
**Example Response:**
```
1640995200,Hello World!
1640995260,Another entry
```
### Response Codes
- `200`: Success (entry saved or contents returned)
- `400`: Missing required parameters
- `401`: Invalid password
- `405`: Method not allowed (non-GET requests)
- `500`: Server error
## Development
### Local Development
```bash
npm run dev
```
### Testing Locally
The worker will be available at `http://localhost:8787` when running locally.
**Note**: Local development requires setting up R2 bucket access. You may need to configure local R2 credentials or use `--remote` flag:
```bash
npm run dev -- --remote
```
### File Format
Entries are stored in `journal.txt` with the format:
```
{unix_timestamp},{url_decoded_text}
{unix_timestamp},{url_decoded_text}
...
```
## Continuous Deployment
The repository includes a GitHub Action that automatically deploys to Cloudflare Workers when changes are pushed to the `main` branch.
### Setup GitHub Secrets
Add these secrets to your GitHub repository settings:
1. **CLOUDFLARE_API_TOKEN**: Create an API token at https://dash.cloudflare.com/profile/api-tokens
- Use the "Custom token" template
- Permissions: `Zone:Zone:Read`, `Zone:Zone Settings:Edit`, `Account:Cloudflare Workers:Edit`
- Account Resources: Include your account
- Zone Resources: Include your zones (if any)
2. **CLOUDFLARE_ACCOUNT_ID**: Copy from `npx wrangler whoami` or find in your (Cloudflare dashboard)[https://developers.cloudflare.com/fundamentals/account/find-account-and-zone-ids/]
### Manual Deployment
You can still deploy manually using:
```bash
npm run deploy
```
## Security Notes
- The `SECRET_PASSWORD` is stored as a Cloudflare Worker secret (encrypted at rest)
- Authentication failures return empty responses to avoid information leakage
- All errors are logged to console for debugging while returning generic error messages to clients