Update README.md
This commit is contained in:
parent
8a01803fae
commit
c8a52a32b3
30
README.md
30
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 <staging|production>
|
||||
```
|
||||
|
||||
# License
|
||||
Contributing bug reports
|
||||
------------------------
|
||||
|
||||
We use [GitHub][github issues] for bug tracking. Security issues should be sent to <a href="mailto:security@signal.org">security@signal.org</a>.
|
||||
|
||||
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
|
||||
|
||||
Loading…
Reference in New Issue
Block a user