https://github.com/bahner/go-ma-actor
A simple client program to send messages using 間
https://github.com/bahner/go-ma-actor
Last synced: about 2 months ago
JSON representation
A simple client program to send messages using 間
- Host: GitHub
- URL: https://github.com/bahner/go-ma-actor
- Owner: bahner
- License: gpl-3.0
- Created: 2023-11-03T01:28:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-26T21:21:13.000Z (4 months ago)
- Last Synced: 2025-02-10T13:37:50.912Z (4 months ago)
- Language: Go
- Size: 1.88 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github.com/bahner/go-ma-actor
This is go-ma-actor based on [an example from go-libp2p][src].
## Requirements
This is a distributed app that relies heavily on the [libp2p](https://libp2p.io/) stack
and [IPFS][ipfs] in particular. It's unusable unless you have a running IPFS node.
I suggest using [Brave Browser][brave] or [IPFS Desktop][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
```bash
# 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
[src]: https://github.com/libp2p/go-libp2p/tree/master/examples/pubsub/chat
[brave]: (Recommended Browser for 間)
[desktop]: (IPFS Desktop)
[ipfs]: (IPFS)