You need to install FProxy on your computer.
System requirements
Minimum system requirements for FProxy:
Operating system:
- Linux: Any Linux distribution that can run Node.js 12.18.1 (such as Debian, Fedora, openSUSE, and Ubuntu)
- Mac: macOS 10.12 Sierra
- Windows: Windows 10 (64-bit) version 1709 (Fall Creators Update)
- nvm 0.35.3 (optional, but recommended)
- Node.js 12.18.1 (optionally installed using nvm)
- npm 6.14.5 (installed with Node.js)
- In Windows, Windows Subsystem for Linux (WSL)
- Graniitti API access token
FProxy may also work with older software versions. The software versions listed above represent the minimum versions FProxy officially supports.
In Windows, nvm, Node.js, and npm are required within the WSL, not in the Windows main system.
Installing FProxy
Before proceeding with the installation, make sure your computer meets the system requirements.
While the following instructions assume that you install FProxy locally on your computer, you can also install FProxy globally in a server environment, allowing multiple users to share the same installation.
Installing FProxy on Linux
You must have administrative privileges to install FProxy.
To install FProxy on Linux:
Install Node.js and npm, if you have not already. The Node.js installation package includes npm. It is recommended that you use nvm to manage your Node.js installations.
You must use mutually compatible versions of Node.js and npm. You may end up with a version mismatch if you install or update the two separately. If you use nvm to manage your installations, the versions are always compatible.
Open your terminal, and go to the directory where you want to install FProxy. If the directory does not exist, create it. The following example creates and opens the
fproxy_install
subdirectory in your home directory:mkdir ~/fproxy_install cd ~/fproxy_install
Download the FProxy installation package to the current directory. The following example uses GNU Wget to download the package:
wget https://inpref-devtools.s3.amazonaws.com/fproxy/fproxy.zip
Unzip the package to the current directory. The following example uses
unzip
to unzip the package:unzip fproxy.zip
Install FProxy by running
npm install -g
with administrative privileges. The following example usessudo
for the privileges:sudo npm install -g
Installing FProxy on macOS
You must have administrative privileges to install FProxy.
To install FProxy on macOS:
Install Node.js and npm, if you have not already. The Node.js installation package includes npm. It is recommended that you use nvm to manage your Node.js installations.
You must use mutually compatible versions of Node.js and npm. You may end up with a version mismatch if you install or update the two separately. If you use nvm to manage your installations, the versions are always compatible.
Open your terminal, and go to the directory where you want to install FProxy. If the directory does not exist, create it. The following example creates and opens the
fproxy_install
subdirectory in your home directory:mkdir ~/fproxy_install cd ~/fproxy_install
Download the FProxy installation package to the current directory using cURL:
curl -O https://inpref-devtools.s3.amazonaws.com/fproxy/fproxy.zip
Unzip the package to the current directory:
unzip fproxy.zip
Install FProxy by running
npm install -g
with administrative privileges:sudo npm install -g
Installing FProxy on Windows
To install FProxy on Windows:
Installing the Windows Subsystem for Linux
The Windows Subsystem For Linux (WSL) is an installation prerequisite for FProxy on Windows 10.
To install and set up the WSL:
Check that your Windows 10 version is 1709 (Fall Creators Update) or newer. If you're running an older version, update to the latest version.
- For instructions on how to check your Windows version, see Which Windows operating system am I running? at Microsoft Support.
- For instructions on how to update Windows, see Microsoft Support.
Install the WSL with Ubuntu. For instructions, see the installation guide at Microsoft Docs.
While FProxy and the WSL support multiple Linux distributions, these instructions assume that you install the WSL with Ubuntu.
- Open the WSL Bash, and run the following commands to set up the WSL:
Update your Linux installation:
sudo do-release-upgrade sudo apt-get update sudo apt-get dist-upgrade
Install Node.js and npm. The following example uses nvm to install Node.js and thereby also npm:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash # Close and reopen Bash nvm install stable
You must use mutually compatible versions of Node.js and npm. You may end up with a version mismatch if you install or update the two separately. If you use nvm to manage your installations, the versions are always compatible.
You can download and install the latest nvm version, rather than the version used above.
Install the programs required by FProxy:
sudo apt-get install python sudo apt-get install g++
Create a symbolic link to your Windows storage directory. This allows you to edit files in a Windows application, such as your source code editor, and have those same files easily available in the WSL. The storage directory can be located anywhere in your Windows file system, but it must exist before creating the symbolic link. Use the following command syntax:
ln -s /mnt/<windows_drive_letter>/<directory_path> <symbolic_link>
The following example creates the symbolic link
dev
in your home directory and points the link to theC:\dev
directory in Windows:ln -s /mnt/c/dev ~/dev
In the WSL, your entire Windows file system is accessible from the
/mnt
directory.
Installing the FProxy package
To install the FProxy package:
Open the WSL Bash, and go to the directory where you want to install FProxy. If the directory does not exist, create it. The following example creates and opens the
fproxy_install
subdirectory in your home directory:mkdir ~/fproxy_install cd ~/fproxy_install
Download the FProxy installation package to the current directory using cURL:
curl -O https://inpref-devtools.s3.amazonaws.com/fproxy/fproxy.zip
Unzip the package to the current directory:
unzip fproxy.zip
If you do not have
unzip
installed, run the following command:sudo apt-get install unzip
Install FProxy:
npm install -g
Updating FProxy
Checking whether you need to update
To check the latest available FProxy version, see FProxy.
To check your current FProxy version:
- Open your terminal.
- Run
fproxy version
from any directory.
Updating FProxy on Linux
To update FProxy on Linux:
Open your terminal, and go to the directory where you installed FProxy. The following example opens the
fproxy_install
subdirectory in your home directory:cd ~/fproxy_install
Download the latest FProxy installation package to the current directory. The following example uses GNU Wget to download the package:
wget https://inpref-devtools.s3.amazonaws.com/fproxy/fproxy.zip
Unzip the package to the current directory (overwriting all files). The following example uses
unzip
to unzip the package:unzip -o fproxy.zip
Updating FProxy on macOS and Windows
To update FProxy on macOS and Windows:
Open your terminal, and go to the directory where you installed FProxy. The following example opens the
fproxy_install
subdirectory in your home directory:cd ~/fproxy_install
Download the latest FProxy installation package to the current directory using cURL:
curl -O https://inpref-devtools.s3.amazonaws.com/fproxy/fproxy.zip
Unzip the package to the current directory (overwriting all files):
unzip -o fproxy.zip
Uninstalling FProxy
Uninstalling FProxy on Linux
You must have administrative privileges to uninstall FProxy.
To uninstall FProxy on Linux:
Open your terminal, and run
npm uninstall fproxy -g
with administrative privileges from any directory. The following example usessudo
to uninstall FProxy with administrative privileges:sudo npm uninstall fproxy -g
Remove the FProxy installation directory and all its contents. Use the following command syntax:
rm -rf <fproxy_directory>
The following example removes the
fproxy_install
subdirectory from your home directory:rm -rf ~/fproxy_install
Uninstalling FProxy on macOS and Windows
You must have administrative privileges to uninstall FProxy on macOS.
To uninstall FProxy on macOS and Windows:
Open your terminal, and run
npm uninstall fproxy -g
from any directory:macOS:
sudo npm uninstall fproxy -g
Windows:
npm uninstall fproxy -g
Remove the FProxy installation directory and all its contents. Use the following command syntax:
rm -rf <fproxy_directory>
The following example removes the
fproxy_install
subdirectory from your home directory:rm -rf ~/fproxy_install