4points/realm repository overview

⁠Realm Docker Image

Realm⁠ is a simple, high performance relay server written in rust.

Realm created by @zhboner⁠'s repo

• Zero configuration. Setup and run in one command.
• Concurrency. Bidirectional concurrent traffic leads to high performance.
• Low resources cost.

⁠Statement

• You can run this container on the X86_64 amd64 or the same arm devicearm32v6, arm32v7, arm64v8.
• The container is still in beta and may not work on some devices.

⁠Usage

If you need to know more about the usage, Please visit the realm repo⁠.

⁠Docker

1. You can simply run this container : An example to listen on port 6060 and forwarding traffic to example.com:443 like below

-r for remote_address can support domain name and ip_address

docker run -itd \
   --name realm \
   -p 6060:6060/tcp \
   -p 6060:6060/udp \
   --restart always \
   4points/realm \
   -l 0.0.0.0:6060 -r example.com:443

2. You can create a configuration file /etc/realm/realm-server.toml in host at first：

• Can be used in host mode

$ mkdir -p /etc/realm

Create a sample in Toml like below:

Remote_addr can support domain name and ip_address

$ cat > /etc/realm/realm-server.toml <<EOF
[log]
level = "warn"
output = "/etc/realm/realm.log"

[network]
no_tcp = false
use_udp = true

[[endpoints]]
listen = "0.0.0.0:6060"
remote = "example.com:443"
EOF

There is an example to start a container that listens on 6060 (both TCP and UDP):

$ docker run -itd \
   --name realm \
   -p 6060:6060/tcp \
   -p 6060:6060/udp \
   --restart always \
   -v /etc/realm:/etc/realm \
   4points/realm \
   -c /etc/realm/realm-server.toml

• There is an example of starting a container in host mode:

$ docker run -itd \
   --name realm \
   --net host \
   --restart always \
   -v /etc/realm:/etc/realm \
   4points/realm \
   -c /etc/realm/realm-server.toml

Warning : The port number must be same as configuration and opened in firewall.