Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexraskin/sharexworker
Serverless ShareX uploader
https://github.com/alexraskin/sharexworker
cloudflare-workers honojs serverless sharex-uploader
Last synced: about 9 hours ago
JSON representation
Serverless ShareX uploader
- Host: GitHub
- URL: https://github.com/alexraskin/sharexworker
- Owner: alexraskin
- License: mit
- Created: 2024-11-25T16:21:10.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-23T17:16:59.000Z (1 day ago)
- Last Synced: 2025-01-23T18:24:57.602Z (about 23 hours ago)
- Topics: cloudflare-workers, honojs, serverless, sharex-uploader
- Language: TypeScript
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ShareXWorker
ShareXWorker is a serverless file uploader designed for seamless integration with ShareX, powered by Cloudflare Workers and Hono.js. This project allows users to upload images with minimal setup. Inspired by [ShareX-R2-Cloudflare-Workers](https://github.com/Cherry/ShareX-R2-Cloudflare-Workers).
## Features
📤 File Upload: Handles binary file uploads effortlessly.
🌐 Serverless: Built on Cloudflare Workers for scalability and low-latency performance.
⚡ Fast and Lightweight: Uses Hono.js for a compact and efficient backend.
🛠️ Custom ShareX Integration: Easily configurable for ShareX uploads.
## Prerequisites
- A domain with Cloudflare DNS
- Cloudflare ClI (Wrangler)
## Installation
Clone the repository:
```cli
git clone [email protected]:alexraskin/ShareXWorker.git
cd ShareXWorker
```
Install the dependencies:
```cli
npm install
```
Edit the `wrangler.toml` file with the R2 bucket, Auth token variable, and the routes.
- [Token Generator](https://it-tools.tech/token-generator)
Edit the `sharex.config.sxcu` file with your domain, Auth token and name.
- Note: Do not remove the `Bearer` prefix from the Auth token.
Deploy the worker:
```cli
npm run deploy
```
## Usage
1. Open ShareX and open the `sharex.config.sxcu` file.
2. Profit!
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.