Skip to content

Latest commit

 

History

History
80 lines (54 loc) · 1.98 KB

DETAILS.md

File metadata and controls

80 lines (54 loc) · 1.98 KB

Starlight Proxy

Prebuild Docker Image and Docker-Compose

The prebuild image is available in

ghcr.io/mc256/starlight/proxy:latest
registry.yuri.moe/starlight-proxy:latest

Please first clone this project and go to the proxy demo folder

git clone https://github.com/mc256/starlight.git
cd ./starlight/demo/compose/proxy

In config.env and then launch the proxy using docker-compose up -d. The proxy listens on port 8090.

Starlight Snapshotter

1. Prerequisites

Starlight depends on containerd. Please install containerd follow the instructions on containerd's Github repository.

To enable the Starlight snapshotter plugin, add the following configuration to /etc/containerd/config.toml

[proxy_plugins]
  [proxy_plugins.starlight]
    type = "snapshot"
    address = "/run/starlight-grpc/starlight-snapshotter.socket"

2. Build From Source

Checkout this repository

git clone [email protected]:mc256/starlight.git

Build and install this project

make && sudo make install

3. Run this project

starlight-grpc run --server $STARLIGHT_PROXY_ADDRESS --socket /run/starlight-grpc/starlight-snapshotter.socket

or uses systemd service in ./demo/deb-package/debian/starlight.service

Other configurations

Latency can impact the available bandwith if the TCP window is too small. Please use the following configurations in /etc/sysctl.conf to increase the default TCP window size or compute a suitable configuration using https://www.speedguide.net/bdp.php.

net.core.wmem_max=125829120
net.core.rmem_max=125829120
net.ipv4.tcp_rmem= 10240 87380 125829120
net.ipv4.tcp_wmem= 10240 87380 125829120
net.ipv4.tcp_window_scaling = 1
net.ipv4.tcp_timestamps = 1
net.ipv4.tcp_sack = 1
net.ipv4.tcp_no_metrics_save = 1
net.core.netdev_max_backlog = 10000

After setting the new TCP window in /etc/sysctl.conf, use sysctl -p to apply the configuration.