Install
Set up the on‑prem server in minutes. Keep your existing project folders and network workflow.
1. Unzip the server package
Download ProjectRelaySetup.zip and unzip it into a temporary folder,
such as your Desktop or C:\Temp. The installer will ask where
to place the final server folder (for example C:\ProjectRelay),
so you do not need to unzip directly into the final location.
2. Run the installer script
- Open PowerShell as Administrator.
-
If PowerShell blocks script execution, run:
Set-ExecutionPolicy Bypass -Scope Process -Force cdinto the folder where you unzipped the file.- Run
.\Install-ProjectRelayServer.ps1.
The installer will:
- Prompt for the install folder (default is typically
C:\ProjectRelay). - Prompt for the network share where uploaded photos should be stored.
- Prompt for the server port (default
5001). - Copy the server files and create
config.json. - Register the
ProjectRelayServerstartup task and start it in the background. - Display the upload URL for use in the ProjectRelay app (for example
http://yourserver:5001/upload).
3. Point ProjectRelay at your server
Ensure the server machine has a fixed hostname or IP. In the ProjectRelay Android app, enter the upload URL shown by the installer, for example:
http://yourserver:5001/upload
4. Apply your license (enable uploads)
- Purchase a license from the licensing page.
-
A license file will download (for example
projectrelay.license.json). Place this file in yourC:\ProjectRelayfolder or whereverProjectRelayServer.exewas installed. - The server should find the license on its own as soon as a request is sent from the app.
Restarting the Project Relay server
A helper PowerShell script is provided in the server folder to restart the background task after you update configuration file. Double-click it or run it from an elevated PowerShell window as needed.
Uninstalling and backing up your license
When you no longer need Project-Relay on a server, use the uninstall script in the server folder.
Before you uninstall, make a copy of your license file (for example
projectrelay.license.json). The uninstall process removes the entire
server folder, including the license file.