Skip to content
Guy Davis edited this page Jul 12, 2021 · 25 revisions

Start a Discussion or join our Discord for support and to help out.

Machinaris runs well inside Docker on MacOS (Intel) systems, though unfortunately not yet MacOS (Apple) systems. The following guide covers a standalone install on a single machine. Once launched, you'll just browse to http://localhost:8926.

Standalone

Machinaris also supports monitoring and controlling multiple workers on your local-area-network.

Pre-requisites

You'll need a recent Docker installed.

Install and Launching

Most users will want to run a full-node with all services started and full-functionality available. This launch commands will pull the most recent Docker image released.

Example launch on MacOS:

docker run --name machinaris -d -t -h $(hostname -s) \
    -p 8444:8444 -p 8926:8926 \
    -e TZ=America/Edmonton \
    -v "~/.machinaris:/root/.chia:rw" \
    -v /Volumes/MyVolume1/plotting:/plotting:rw \
    -v /Volumes/MyVolume2/plots:/plots:rw \
    ghcr.io/guydavis/machinaris

Change the following host paths and variables highlighted in bold, before running the command above:

  • /Volumes/MyVolume2/plots: Will hold the finished plot files after plotting and when farming.
  • /Volumes/MyVolume1/plotting: Should be your fast temporary plotting space.
  • America/Edmonton: Change to your local timezone.

Browse to http://localhost:8926 to view the WebUI. To stop Machinaris container, you can run docker stop machinaris or similar.

Docker Compose

Here's an example config for use with Docker Compose, if you prefer that to docker run:

  machinaris:
    container_name: machinaris
    image: ghcr.io/guydavis/machinaris
    restart: always
    tty: true
    hostname: HOSTNAME_OF_COMPUTER
    ports:
      - "8444:8444"
      - "8926:8926"
    volumes:
      - "/home/USER/.machinaris:/root/.chia:rw"
      - "/path/to/plotting:/plotting:rw"
      - "/path/to/plots:/plots:rw"
    environment:
      - TZ=$TZ

As above, change the following host paths and variables highlighted in bold, before running the command above:

  • /home/USER/.machinaris: Will hold the application data, config, and logs for Chia, Plotman, and Machinaris.
  • /path/to/plots: Will hold the finished plot files after plotting and when farming.
  • /path/to/temp: Should be your fast temporary plotting space.
  • America/Edmonton: Change to your local timezone.
  • HOSTNAME_OF_COMPUTER: Change to the same hostname as the real computer running Docker.

Other Modes

A Machinaris plotter is a remotely-controlled worker. Please see the Workers page for details on launching a plotter, a harvester, a harvester+plotter instead.

Post-Install Configuration

Once you have launched Machinaris, be sure to do the following, regardless of which platform you are using. For fullnode (default) and farmer modes, you'll need to either import a key or generate a new one as described below. Plotter and harvester modes DO NOT require key import or generation (see steps above).

Import Key Mnemonic

Just browse to http://localhost:8926 where you can either import an existing key or generate a new one:

GenerateKey

Port-Forward TCP/8444

For your full-node, you should port-forward your router back to your Docker container on port tcp/8444. This is required to stay synced and thus participating in farming challenges.

Here's an example port-forward config from my Unifi-router:

PortForward

Clone this wiki locally