Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 1.9 KB

README.md

File metadata and controls

64 lines (42 loc) · 1.9 KB

github.com/bahner/go-ma-actor

This is go-ma-actor based on an example from go-libp2p.

Requirements

This is a distributed app that relies heavily on the libp2p stack and IPFS in particular. It's unusable unless you have a running IPFS node.

I suggest using Brave Browser or IPFS Desktop to run and IPFS node.

By using Brave browser your can run an IPFS node without installing anything. And you can investigate the IPFS network with the built-in IPFS node. It provides The ability to browse IPFS properly, and to pin files and directories.

Cros-compiling

Cross-compiling for Windows requires gcc-mingw-w64 and gcc-multilib tools to be installed.

TL;DR

# Generate persistent config file with *SECRETS*
# The public parts needs to be published to the IPFS network to be useful, hence
# this takes a while. Sometimes 10 seconds, but also 3 minutes.
./actor --generate
./actor # Share and enjoy!

Configuration

type ./go-ma-actor -help.

The configuration is store in the appropriate XDG folders. To see the config use ./actor --show-config.

On POSIX system this file is in ~/.config/ma.

Identity

A -generate flag is available to generate a new identity. It uses defaults, BUT it generates a new random identity.

You can use the output as your future identity, but keep it secret. Those identities are used to sign messages, and to encrypt and decrypt private messages.

Usage

To quit, hit Ctrl-C, or type /quit into the input field.

Commands

  • /status [sub|topic|host]
  • /discover
  • /alias [node|entity] set [DID|NAME] NAME
  • /aliases
  • /msg Name Message
  • /enter room
  • /refresh