Skip to content

Installation

Twisted edited this page Jun 19, 2021 · 1 revision

Installation

Small guide on how to install portal.

Simple Installation

If you are just looking for a simple, fast transfer proxy then the easiest way to install portal is by downloading the latest release. Download the portal executable file for your operating system and then run the program.

Executables are only provided for Windows (arm/amd64) Linux (arm/amd64) and Darwin (amd64). If you need an executable for a different OS you will need to download the source code and build it yourself.

Advanced Installation

If the default setup of portal is not exactly what you are looking for, you can create a new Go project and use portal as a library to change how it functions.

To get started you can copy the main.go file from the repository and put in to your own project as a base. From there you can use the API to change how the proxy functions for your needs.

Clone this wiki locally