titaniumnet-mirror/ultraviolet
1
0
Fork 0
mirror of https://github.com/titaniumnetwork-dev/Ultraviolet.git synced 2025-05-13 03:50:01 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
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. https://docs.titaniumnetwork.org/proxies/ultraviolet
122 commits 8 branches 34 tags 1.7 MiB
Find a file
David Reed 561a1ee190
run ESLint 
Several bugs were found (and fixed):
src/client/index.js:71
the following if() was equivalent to if (false in obj)

src/client/dom/element.js:207
the following if() was equivalent to if (!element || false in element)

src/client/rewrite/html.js:179
an undefined iterate() was referenced
2022-11-23 12:37:00 -05:00
.github/ISSUE_TEMPLATE prettier 2022-11-18 20:00:58 -05:00
lib Export .uvPath instead of default 2022-10-15 22:55:48 -04:00
src run ESLint 2022-11-23 12:37:00 -05:00
.eslintignore run ESLint 2022-11-23 12:37:00 -05:00
.eslintrc run ESLint 2022-11-23 12:37:00 -05:00
.gitignore build intructions 2022-09-15 17:52:23 -04:00
.prettierignore run ESLint 2022-11-23 12:37:00 -05:00
.prettierrc prettier 2022-11-18 20:00:58 -05:00
CHANGELOG.md bump 2022-10-01 18:26:29 -04:00
LICENSE Create LICENSE 2022-02-24 17:44:44 -05:00
package-lock.json run ESLint 2022-11-23 12:37:00 -05:00
package.json run ESLint 2022-11-23 12:37:00 -05:00
README.md add NPM badge 2022-11-19 18:35:03 -05:00
webpack.config.js run ESLint 2022-11-23 12:37:00 -05:00

README.md

Ultraviolet

npm version

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!

Documentation

Documentation can be found in the wiki.

How do I deploy/run this?

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

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.

I don't care about building, where are the scripts for my website?!

You can extract the scripts from the NPM package in the releases section. All the scripts you would typically look for (uv.bundle.js, uv.handler.js, uv.sw.js, and uv.config.js) are found within the dist directory.

If you cannot open the tar.gz (Chrome OS?), use a converter. We can only do so much to make the scripts accessible.

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-dev/Ultraviolet/releases/download/v1.0.1/ultraviolet-1.0.1.tgz

How do I build this?

  1. Clone the repository
$ git clone https://github.com/titaniumnetwork-dev/Ultraviolet.git
> Cloning into Ultraviolet...
$ cd Ultraviolet
  1. Install dependencies
$ npm install
  1. Produce the dist/ directory and compile scripts
$ npm run build

Packaging

This is intended for releasing on hosting the package as a file, not on NPM.

$ npm pack

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