49 lines
1.8 KiB
Markdown
49 lines
1.8 KiB
Markdown
<p align="center"><img src="https://raw.githubusercontent.com/titaniumnetwork-development/Ultraviolet-Static/main/public/uv.png" height="200"></p>
|
|
|
|
<h1 align="center">Ultraviolet</h1>
|
|
|
|
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](https://github.com/tomphttp).
|
|
|
|
See the [changelog](./CHANGELOG.md) 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](https://github.com/titaniumnetwork-development/Ultraviolet-Node) for easy instructions to deploy an Ultraviolet website.
|
|
|
|
An example of REALLY using this (API, copying files, etc) is in [Ultraviolet-Static](https://github.com/titaniumnetwork-development/Ultraviolet-Static). See [scripts/build.js](https://github.com/titaniumnetwork-development/Ultraviolet-Static/blob/main/scripts/build.js).
|
|
|
|
## How do I package this?
|
|
|
|
```sh
|
|
$ git clone https://github.com/titaniumnetwork-development/Ultraviolet.git
|
|
> Cloning into Ultraviolet...
|
|
$ cd Ultraviolet
|
|
```
|
|
|
|
```sh
|
|
$ npm install
|
|
```
|
|
|
|
```sh
|
|
$ npm run build
|
|
```
|
|
|
|
```sh
|
|
$ 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](https://github.com/titaniumnetwork-development/Ultraviolet/releases). Copy the link to the `.tgz` and install using NPM.
|
|
|
|
```sh
|
|
$ npm install https://github.com/titaniumnetwork-development/Ultraviolet/releases/download/v1.0.1/ultraviolet-1.0.1.tgz
|
|
```
|