Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Docker: Installing & Running

Advanced Users Only

Installing and running the Master Node CLI is for advanced users only. If you do not know what you are doing, please follow the GUI: Installing & Running tutorial instead.

Prerequisites

  • Docker Engine ≥ 24.0

  • Master Node License Key (only necessary if running headless)

1. Pull latest image

Pull the latest Docker image by running the following in your terminal:

docker pull ghcr.io/playa3ull/node

2. Run image

Now that you have pulled the latest Docker image, run the image by:

docker run ghcr.io/playa3ull/node

You will be prompted to login by authenticating your account via the dApp, which upon signing will automatically login the Master Node CLI to your account.

Once authenticated, you will be logged in and connected to the network!

Keep the software logged in and running in order to be eligible for rewards.

2.1 Optional Arguments

If you are running the Mater Node CLI on a machine/environment with interactivity, you can include the -it flag to interact with the built-in menu features.

2.2 Headless

In headless environments, you can authenticate with your Master Node by using it's associated license key, available via the Account page on the dApp.

Passing as argument flag

The Master Node CLI can be ran with an optional license key argument flag to authenticate the service with the linked Master Node as:

Passing as environment variable

You can pass the license key through to the Master Node CLI via an environment variable when running the application:

Interface Flicker

Whilst running the Master Node CLI, you may notice flickering occurring. This is due to how the CLI interface is updated to show your uptime, new activity logs, etc.

This is something we will continue to improve, and aim to have completely fixed by the full release of the software.

In the interim, you can customize the refresh rate of the CLI via the TERMINAL_REFRESH_RATE environment variable, which dictates the refresh rate of the CLI in milliseconds.

The above command will refresh the terminal every 30 seconds.

Troubleshooting Logs

Logs help us find the root cause of the issue you encountered faster, always remember to submit a log file with your reports.

Logs can be found via the container file system at tmp/PLAYA3ULL GAMES/node/logs. Please supply a log file when submitting a report.

Last updated