# 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/0.0.20/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. Now you are ready to launch the caster.

./yccaster

Caster will start on default NTRIP port 2101.

# Linux service

It is not convenient to hold the caster process in foreground mode on a local machine. If you are going to have a permanent establishment, it makes sense to install caster on a remote virtual private server. We would recommend Digital ocean (opens new window) or Linode (opens new window). Both of them provide cheap VPS for $5 a month that perfectly fit for beginners.

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/0.0.20/linux-amd64/yccaster -O /var/caster/yccaster && chmod +x /var/caster/yccaster

Go to caster folder

cd /var/caster

Generate caster config

./yccaster init

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 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 Show version
update Update caster to the latest version