Skip to content

gladiusio/gladius-node

Repository files navigation

Gladius Node

The full suite of Gladius binaries (Network Gateway, EdgeD, CLI, and Guardian) to run a node.

Current Build Status

  • Build Status - Node
  • Build Status - Network Gateway
  • Build Status - EdgeD
  • Build Status - CLI

Install

Windows and macOS : https://gladius.io/download

  • Windows: Open gladius setup.exe and use the installer
  • macOS: Open the DMG and drag Gladius to the Applications folder

Linux : curl -s https://raw.githubusercontent.com/gladiusio/gladius-node/master/installers/install.sh | sudo bash

Forward Ports : All platforms by default need ports 8080 and 7947 forwarded to the node

Use

Windows and macOS

  1. Download and install (see above)
  2. Open the Gladius application
  3. Follow the instructions in the user interface
  4. You can close the application and it will run in the background

Windows: To turn off the application completely use the task manager (Kill gladius-guardian/edged/network-gateway) this will be changed in next release.

macOS: To turn off the application completely use the menu bar (Right click Gladius -> Quit all)

Linux

  1. sudo gladius-guardian install (Install guardian as service)
  2. sudo gladius-guardian start (Start it as a service with systemd. It will start up automatically on reboot)
  3. gladius start (Instruct Guardian to start Gladius services. This needs to be done after reboot)
  4. gladius Use the CLI!

Docker

  1. Clone this repo, git clone git@github.com:gladiusio/gladius-node.git
  2. Navigate to the gladius-node directory
  3. Run docker-compose up to start services

Services via Docker should now be running. You will have to create / open a wallet before use via curl

NOTE: All install does is create a systemd service for the guardian, if you don't want to do that you can run it in a seperate window by calling gladius-guardian

Development and Contributions

If you would like to contribute to the project:

  1. Fork the repository you would like to edit (likely Network Gateway, EdgeD, CLI, or Guardian)
  2. Make your changes
  3. Make a pull request
  4. Send an email to cla@gladius.io to sign our Contributor Licensing Agreement

Building the Gladius Node from source

Our builds are done inside containers to allow easier cross platform CGO development, so you will need docker to build the binaries.

To change the git version (or git URL) that is checked out, modify the .env file. If you modify the directories or the URLs, you will want to run make docker-image to update the image.

  • First run make docker-image or docker pull gladiusio/node-env

  • To build (run with -j 4 to run these jobs in parallel)

    • make to build binaries for all supported operating systems
    • make binaries-<os> to build for a specific OS
  • To release

    • make releases to build all release tarballs

All output will be placed in your local ./build