@titaniumnetwork-dev/ultraviolet

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!

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-development/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-development/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

Changelog

v1.0.3

• In previous versions, the uvPath export was the default export from the Ultraviolet module. In this version, uvPath is no longer the default export and needs to be imported explicitly.
• Here is an example of how to import the library:

import { uvPath } from "@titaniumnetwork-dev/ultraviolet";