From c8a52a32b38479f749e98d86255a0083ab8c3726 Mon Sep 17 00:00:00 2001 From: Chris Eager Date: Wed, 12 Feb 2025 15:41:52 -0600 Subject: [PATCH] Update README.md --- README.md | 30 ++++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1470f24..186b124 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ -# Overview +TUS Server +========== 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 +Building +-------- + You'll need [Node.js](https://nodejs.org/). If you use [nvm](https://github.com/creationix/nvm) run ``` nvm use @@ -15,7 +18,8 @@ npm 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 +Testing +------- The server assumes an authentication is provided via a signature using a shared secret. You can provide one for development by setting `SHARED_AUTH_SECRET` in `.dev.vars`, e.g. ``` @@ -33,9 +37,10 @@ To run unit tests, npm test ``` -# Deploying +Deploying +--------- -## One time setup +### One time setup 1. Create an R2 bucket and update the binding in `wrangler.toml` 2. Add a base64 encoded shared auth secret with `wrangler secret put SHARED_AUTH_SECRET` @@ -43,9 +48,22 @@ npm test wrangler deploy -e ``` -# License +Contributing bug reports +------------------------ + +We use [GitHub][github issues] for bug tracking. Security issues should be sent to security@signal.org. + +Help +---- + +We cannot provide direct technical support. Get help running this software in your own environment in our [unofficial community forum][community forum]. + +License +------- Copyright 2023 Signal Messenger, LLC Licensed under the [AGPLv3](LICENSE) +[github issues]: https://github.com/signalapp/tus-server/issues +[community forum]: https://community.signalusers.org