RevelaNetwork/Revela
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
A highly sophisticated proxy used for evading internet censorship or accessing websites in a controlled sandbox using the power of service-workers. Works by intercepting HTTP requests with a service worker script that follows the TompHTTP specifications.
70 commits 1 branch 0 tags 903 KiB
JavaScript 100%
Find a file
David Reed c1b9d27642 document
2022-09-15 18:14:52 -04:00
.github/ISSUE_TEMPLATE Issue template 2022-03-28 16:38:52 -04:00
lib bundle & copy files, provide an API for using a packaged version of ultraviolet 2022-09-15 17:36:42 -04:00
src break serviceworkers 2022-09-15 18:08:01 -04:00
.gitignore build intructions 2022-09-15 17:52:23 -04:00
CHANGELOG.md bump to 1.0.1, log new sw.js format 2022-09-15 18:08:25 -04:00
LICENSE Create LICENSE 2022-02-24 17:44:44 -05:00
package-lock.json bump to 1.0.1, log new sw.js format 2022-09-15 18:08:25 -04:00
package.json bump to 1.0.1, log new sw.js format 2022-09-15 18:08:25 -04:00
README.md document 2022-09-15 18:14:52 -04:00
webpack.config.js bundle & copy files, provide an API for using a packaged version of ultraviolet 2022-09-15 17:36:42 -04:00

README.md

Ultraviolet

Advanced web proxy used for evading internet censorship or accessing websites in a controlled sandbox.

Ultraviolet works by intercepting HTTP requests with a service worker script that follows the TompHTTP specifications.

See the changelog if you're using v1.0.1 or above!

How do I deploy/run this?

This repository is the bare-bones of Ultraviolet. This only contains the source code required to compile uv.bundle.js.

See Ultraviolet-Node for easy instructions to deploy an Ultraviolet website.

An example of REALLY using this (API, copying files, etc) is in Ultraviolet-Static. See scripts/build.js.

How do I package this?

$ git clone https://github.com/titaniumnetwork-development/Ultraviolet.git
> Cloning into Ultraviolet...
$ cd Ultraviolet

$ npm install

$ npm run build

$ npm pack

Package will be named ultraviolet-X.X.X.tgz

How do I install this?

This will provide built files and the JS API to access the path of dist files.

Currently, we don't have an NPM package. As a current solution, you can install from a GitHub release. Copy the link to the .tgz and install using NPM.

$ npm install https://github.com/titaniumnetwork-development/Ultraviolet/releases/download/v1.0.1/ultraviolet-1.0.1.tgz