go-ma-actor

module
v0.4.0 Latest Latest
Warning

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

Go to latest
Published: Apr 7, 2024 License: GPL-3.0

README

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.
./go-ma-actor --generate --nick "asj" --publish > actor.yaml
./go-ma-actor # Share and enjoy!

Configuration

type ./go-ma-actor -help. Most config settings can be set with environment variables, as follows:

export GO_MA_LOG_LEVEL="error"
export GO_MA_LIBP2P_DISCOVERY_TIMEOUT="300"
export GO_MA_ACTOR_IDENTITY="myBase58EncodedPrivkeyGeneratedByGenerate"

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

Jump to

Keyboard shortcuts

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