Manually Deploying Node and Gateway Binaries

From xx network wiki
Revision as of 17:05, 15 October 2021 by Anne (talk | contribs) (Protected "Manually Deploying Node and Gateway Binaries" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
This is a team contributed page

Typical installs of cMix and Gateway use the initial binaries provided on the xx network website and receive updates from the Wrapper Script. However, Node operators have the option to disable the wrapper script updates and use a manually compiled binary compiled from the cMix or Gateway source.

Disable Wrapper Script Updates

Disabling updates from the Wrapper Script will allow the use of alternate binaries. However, failure to run up-to-date software is the responsibility of the Node operator and failure to do so can leave a Node or Gateway nonoperational.

  1. Add --disableupdates to the call in the service files located in /opt/xxnetwork/xxnetwork-cmix.service for cMix and /opt/xxnetwork/xxnetwork-gateway.service for Gateway.

  2. Restart the service.

    For cMix:

    For Gateway:

Compile Binaries

Before compiling the cMix or Gateway binaries, make sure to follow the Go Environment Set Up.

Gateway Binary

Refer to the build commands in the Gateway .gitlab-ci.yaml file for more information.

  1. Download or git clone the latest master branch of Gateway.

  2. Compile Gateway using the following command.

    It is also possible to compile it for other systems, though support cannot be guaranteed.

  3. Rename the binary to xxnetwork-gateway and move it to /opt/xxnetwork/bin.

  4. Restart the Gateway service.

cMix Binary

If the cMix is expected to run with GPU acceleration, compiling Server requires an extra step. This setup assumes a working Nvidia installation. Refer to the build commands in the Server .gitlab-ci.yaml file for more information.

  1. First, follow the instructions to Set Up GPU for cMix.

  2. Download or git clone the latest master branch of Server.

  3. Compile the Server using the following command.

  4. Rename the binary to xxnetwork-cmix and move it to /opt/xxnetwork/bin.

  5. Restart the Node service.