Skip to content

Latest commit

 

History

History
105 lines (70 loc) · 3.76 KB

README.md

File metadata and controls

105 lines (70 loc) · 3.76 KB
Raw

Metallic

A powerful web proxy build for speed and customization.

Access the web with this stylish new web proxy service made in React supporting many sites. Metallic was originally created for TN's proxathon where it won 2nd place!

Features

  • Simple clean design
  • Support for many popular sites
  • Customizable interface
  • Mobile support
  • Expansive library of themes

Setup

Install Dependencies

Run npm install to install the required dependencies

Run

Run npm start to start a webserver and the Bare server. You may deploy Metallic by using an external bare server and a static file host. Metallic must be built before attempting to start.

Build

Run npm run build to build app for production to the build folder.

Development

Run npm run dev to run the app in development mode.

Deploy

Click a button at the top of this page and follow the directions for an easy way to host Metallic.

Configuration

Obfuscation

File: /src/consts.js

const obfuscation = true | false; - Choose to obfuscate text

Block List

File: /blocklist/block.json

[host, sub.host, host...] - An Array of hostnames to block (also include subdomains)

Github and Discord

File: /src/consts.js

const github = "string"; - Update the Github links

const discord = "string"; - Update the Discord link

Bare Servers

File: /src/consts.js

const bareServerURL = new URL(url); - Main bare server and Stomp bare server

File: /public/uv/uv.config.js

bare: url, - Ultraviolet bare server

File: /public/dip/dip.config.js

bare: {

version: 1 | 2, - DIP bare version

path: url, - DIP bare server

}

File: /public/aero/config.js

const backends = [url]; - Aero bare server

Changelog/Roadmap

Check out the changelog and the roadmap.

Pages

Pages are is the order of 1, 2, 3 etc.

  • / - Home
  • 1.html - Apps
  • 2.html - Games
  • 3 (and 3.html) - Redirects to /3/1.html
    • 3/1.html - Search
    • 3/2.html - Tab
    • 3/3.html - Appearance
    • 3/4.html - UI
  • 4.html - Privacy
  • 5.html - Credits
  • 6.html - Support
  • * - Error

License

Metallic uses the MIT license.