Quick Start

Local

The fastest way to get your caster up and running is to download the latest stable binary file for your operating system and make it executable.

wget https://yccaster.s3.eu-central-1.amazonaws.com/bin/2.1.0/linux-amd64/yccaster && chmod +x yccaster

Then you will need to generate a configuration file.

./yccaster init

caster.yml will appear in the current folder. Configure authorization for bases and rovers before exposing the service. Now you are ready to launch the caster.

./yccaster

Caster will start on default NTRIP port 2101.

Linux service

Run YCCaster as a dedicated service user on a Linux server. The commands below require root privileges.

Create new user

useradd caster

Create new folder and download caster

mkdir -p /var/caster && wget https://yccaster.s3.eu-central-1.amazonaws.com/bin/2.1.0/linux-amd64/yccaster -O /var/caster/yccaster && chmod +x /var/caster/yccaster

Go to caster folder

cd /var/caster

Generate caster config

./yccaster init

Allow the service user to save relay settings. The directory must be writable because YCCaster replaces relays.yml atomically.

chown -R caster:caster /var/caster
chmod 750 /var/caster
chmod 600 /var/caster/caster.yml

Set SystemD config

cat << EOF > /etc/systemd/system/caster.service
[Unit]
Description=YCCaster
Requires=network-online.target
After=network-online.target

[Service]
Type=simple
User=caster
Group=caster
Restart=always
RestartSec=10
WorkingDirectory=/var/caster
ExecStart=/var/caster/yccaster
StandardOutput=append:/var/log/caster.log
StandardError=append:/var/log/caster.log

[Install]
WantedBy=multi-user.target
EOF

Enable caster service

systemctl daemon-reload
systemctl enable caster.service

Start caster service

systemctl start caster.service

Command-line options

Usage:

yccaster [command] [options]

YCCaster supports the following command-line parameters:

Command	Description
help, h	Shows a list of commands or help for one command
init	Generate default configuration file
--version, -v	Show version
update [version]	Update the binary to the latest or specified version

Pull an external stream

From version 2.1.0, YCCaster can connect to an external NTRIP caster and publish its stream to a local mountpoint. Configure it through relays.yml or the authenticated HTTP API. Enabled relays restart automatically with YCCaster.

Follow the Pull relays guide for a complete configuration, API operations, fixed GGA, lifecycle events and nearest-group behavior.

Upgrade an existing installation

Download version 2.1.0 from the Download page or run ./yccaster update 2.1.0 as a user allowed to replace the binary. Restart the service after the update:

systemctl restart caster.service

Keep your existing configuration and license. Relay support does not require regenerating caster.yml; add configuration.relays-file only if you want a path other than the default relays.yml next to caster.yml.