https://github.com/cap-go/hono-r2-tus-uploader
An implementation of the TUS server protocol for resumable uploads
https://github.com/cap-go/hono-r2-tus-uploader
Last synced: 5 months ago
JSON representation
An implementation of the TUS server protocol for resumable uploads
- Host: GitHub
- URL: https://github.com/cap-go/hono-r2-tus-uploader
- Owner: Cap-go
- Created: 2024-09-30T21:17:16.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-11-08T19:04:18.000Z (6 months ago)
- Last Synced: 2024-11-17T06:37:29.888Z (5 months ago)
- Language: TypeScript
- Size: 223 KB
- Stars: 15
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Overview
[](https://deploy.workers.cloudflare.com/?url=https://github.com/Capgo/hono-r2-tus-uploader)
tus-server provides an implementation of the [TUS protocol](https://tus.io) for resumable uploads built on [cloudflare workers](https://www.cloudflare.com/products/workers/) and [R2](https://www.cloudflare.com/products/r2/).
# Building
You'll need [Bun.sh]([https://nodejs.org/](https://bun.sh/)). (The code is in TS, it remove the need to transpile, You can use Nodejs with --experimental-strip-types and npm)
To install dependencies,
```
bun install
```
In order to deploy to cloudflare or use non-local dev mode, use the [`wrangler`](https://developers.cloudflare.com/workers/wrangler/install-and-update/) utility. Follow those instructions to authenticate with your cloudflare account.
# Testing
The server work without authentification, but a empty middleware is provided to help you set it up.
To run a dev server you can interact with over localhost with local wrangler
```
bun run start:server
```
Open another shell and run:
```
bun run start:demo
```
# Deploying
## Notes
Change the auth system, to implement your own current one works with a shared secret, that is used in tus-server and tus-resumable-upload-js
## One time setup
1. Create an R2 bucket and update the binding in `wrangler.toml`
2. Change the auth system to your needs
3. Deploy with wrangler
```
bunx wrangler deploy -e
```
# License
Copyright 2024 Capgo, Digital shift OU
Licensed under the [AGPLv3](LICENSE)
# Credit
This is a hard fork of https://github.com/signalapp/tus-server/blob/main/README.md
Rewrited to work in the [Capgo (live update for CapacitorJS apps)](https://capgo.app) tech stack, and in frontend