Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gbaranski/cryptogram
Decentralized messaging app built on LibP2P
https://github.com/gbaranski/cryptogram
Last synced: 3 months ago
JSON representation
Decentralized messaging app built on LibP2P
- Host: GitHub
- URL: https://github.com/gbaranski/cryptogram
- Owner: gbaranski
- License: gpl-3.0
- Created: 2020-11-16T20:44:53.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-04T09:10:55.000Z (over 3 years ago)
- Last Synced: 2024-06-20T03:49:19.454Z (7 months ago)
- Language: Go
- Homepage:
- Size: 2.87 MB
- Stars: 13
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cryptogram
Decentralized P2P messaging app built on top of [LibP2P](https://libp2p.io/). Currently only CLI version is available.
## Quick start with CLI app
##### Install Go
###### macOS
```bash
brew install go
```
###### Arch Linux
```bash
sudo pacman -S go
```
#### Download repository
```bash
git clone https://github.com/gbaranski/cryptogram # Clone this repo
```
#### Run directly
```bash
# Run with MDNS peer discovery, nickname will be $USER enviroment variable
go run main.go --mdns
# Run with MDNS peer discovery and custom nickname "Charlie"
go run main.go --mdns --nick Charlie
# Run with DHT peer discovery with default bootstrap settings and custom nickname "Charlie"
go run main.go --dht --nick Charlie
```
#### Compile to single executable
```bash
# Compile packages and dependencies into single executable
go build
# Run with DHT peer discovery with default bootstrap settings and custom nickname "Charlie"
./cli -dht --nick Charlie
```
### Configuration
| Name | Description |
| --------------------------- | ------------------------------------------------------------------------------------------ |
| `--nick ` | Sets nickname to identify yourself, by default `$USER` env var, fallbacks to generated one |
| `--dht` | Enables DHT Peer Discovery |
| `--mdns` | Enables MDNS Peer Discovery |
| `--insecure` | Disables security protocols, don't use that |
| `--debug` | Enabled debug mode, more logging |
| `--room ` | Sets the room name you join to at start. Default: `general` |
| `--mdnsinterval ` | Configures MDNS packet inerval, default: 900(15min) |
| `--rendezvousname ` | Sets unique string to identify group of nodes. Default: `cryptogram-rendezvous` |
### Commands
| Name | Description |
| ------------------- | ---------------------------------------- |
| `/help` | Shows available commands |
| `/join ` | Join another room, leave the current one |
| `/topics` | Prints out all subscribed topics |
| `/free` | Removes messages and memory garbage |
| `/stats` | Prints out memory statistics |
| `/exit` | Exits the program |
## Peer discovery
Available methods of peer discovery
#### DHT Peer Discovery
Bootstraping nodes, also known as rendezvous host, used for discovery of new peers, by default it uses the following addresses
```bash
/dnsaddr/bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN
/dnsaddr/bootstrap.libp2p.io/p2p/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa
/dnsaddr/bootstrap.libp2p.io/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb
/dnsaddr/bootstrap.libp2p.io/p2p/QmcZf59bWwK5XFi76CZX8cbJ4BhTzzA3gU1ZjYZcYW3dwt
/ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ # mars.i.ipfs.io
```
#### MDNS Peer discovery
Multicast DNS protocol resolves peers in local network, sends UDP packet every some time to announce ourselfs