File: README.md

package info (click to toggle)
receptor 1.5.5-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,772 kB
  • sloc: python: 1,643; makefile: 305; sh: 174
file content (54 lines) | stat: -rw-r--r-- 1,005 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# receptor - basic example

This example creates two receptor nodes, called `arceus` and `celebi`.

## Diagram

The `ctl.sh` script (equivalent to `receptorctl`) sends the message to Celebi through an unix domain socket `socks/celebi.sock`, then Celebi forwards that message to Arceus through the docker-compose network.

![Receptor simple network diagram](./simple-network-diagram.drawio.png)

## Commands

```bash
# Build and run
docker-compose up -d

# Destroy and cleanup
docker-compose down
rm -rf ./socks/

# Run commands on receptorctl
./ctl.sh <args>

# Examples
./ctl.sh ping celebi
./ctl.sh ping arceus
```

## Config files

Celebi socket is exposed:

Full Celebi config file can be found here: [configs/celebi.yaml](configs/celebi.yaml)

```yaml
...

- control-service:
    service: control
    filename: /socks/celebi.sock
```

Arceus port is exposed:

Full Arceus config file can be found here: [configs/arceus.yaml](configs/arceus.yaml)

```yaml
...

- tcp-listener:
    port: 2223

...
```