chockagent

command module
v1.1.1-0...-b92a7c3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 24, 2020 License: MIT Imports: 7 Imported by: 0

README

ChockAgent

Deploy an agent

The agent must be run on a machine with a local instance of factomd running (API port 8088 open).

# Replace AGENT_NAME environment variable value with a uniquely identifiable name
docker pull luciaptech/chockagent
docker run -d \
    --network host \
    --name chockagent \
    -e AGENT_NAME="luciap-testnet" \
    luciaptech/chockagent

# Verify the agent succesfully connected to the coordinator
docker logs chockagent

Run an agent locally (for development)

The easiest way is to run:

AGENT_NAME="local-chockagent" go run main.go

Available environment variables:

  • AGENT_NAME: An identifying name for the agent (should be unique)
  • FACTOMD_RPC_ENDPOINT: An alternate factomd endpoint. Must include /v2. (default: http://localhost:8088/v2)
  • CHOCKABLOCK_ENDPOINT: An alternate ChockaBlock endpoint. (default: ws://localhost:4007, production: wss://chockagent.luciap.ca)

Build the agent

Running make will build the chockagent. Note that the default chockablock endpoint is set at build time (see Makefile).

docker_push.sh is a basic script building a chockagent Docker image and pushing it to Docker hub. That script uses the latest git tag to version the image: before publishing an updated image you will need to tag the release (e.g. git tag v1.1.1).

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL