Skip to content
Mercury Core

RCCService setup

This guide details how to set up RCCService for local development, moderation, and production publishing. More information, including general details on how RCC works, is available on the RCCService service page.

For the purposes of this guide, a proxy server will be used to start and manage the RCC process and all communications with it. This is the recommended setup for both development and production.

Requirements

Section titled “Requirements”

You will need:

  • Latest version of Git installed (expected as git, optional)
  • Latest version of Go installed (expected as go, installation guide)
  • A terminal

Instructions

Section titled “Instructions”

  1. Clone the tp-link-extender/RCCService repository to a directory of your choice on your local machine, and navigate to the root directory of the repository.

    Terminal window
    git clone https://github.com/tp-link-extender/RCCService
    cd RCCService

  2. Navigate to the Proxy directory. Copy the Proxy/.env.example file to Proxy/.env and modify it to set up the environment variables.

  3. Run go build to compile the proxy server. This will produce an executable file in the same directory, either Proxy.exe on Windows or Proxy on Linux.

  4. Copy both the compiled proxy executable and the Proxy/.env file to their parent directory, the root of the repository. The proxy executable needs to be in the same directory as the RCCService folder to be able to start the RCC process correctly, and the .env file needs to be in the same directory as the proxy executable for the proxy to read its configuration.

  5. Run the proxy executable to start the proxy server and the RCC process. The proxy will automatically restart the RCC process if it crashes or is killed, and will print logs from both itself and the RCC process to the console.

If you're using RCC with Mercury Core, make sure to check its configuration to ensure that the RCCServiceProxyURL property is set to the correct URL of your proxy server, including the appropriate scheme and port. The default value should work correctly if the proxy server is running on the same machine as the Site.