#!/bin/sh # --------------------------------------------------------------------------- # FiveRP - installer # # Turns a clean Ubuntu/Debian box into this server: FXServer artefacts, # cfx-server-data, oxmysql, MariaDB with the schema, the FiveRP resources, # a keep-alive supervisor and a boot entry. # # sudo sh install.sh --licence cfxk_xxxxxxxx # # Options # --licence KEY Cfx.re server key from https://keymaster.fivem.net # --dir PATH install root (default /opt/fivem) # --hostname NAME server name in the list (default FiveRP) # --port N game port (default 30120) # --name NAME service name, one per server (default fiverp) # --db-name NAME database (default fiverp) # --db-user USER database user (default fiverp) # --db-pass PASS password for that user (default: generated) # --build ID FXServer build (default: latest recommended) # --no-start install everything, do not start the server # --------------------------------------------------------------------------- set -e DIR=/opt/fivem LICENCE="" HOSTNAME_="FiveRP" BUILD="" DB_NAME=fiverp DB_USER=fiverp DB_PASS="" PORT=30120 SVC=fiverp START=1 ARTIFACTS="https://runtime.fivem.net/artifacts/fivem/build_proot_linux/master/" OXMYSQL="https://github.com/overextended/oxmysql/releases/latest/download/oxmysql.zip" SERVER_DATA_REPO="https://github.com/citizenfx/cfx-server-data" SRC=$(cd "$(dirname "$0")" && pwd) while [ $# -gt 0 ]; do case "$1" in --licence|--license) LICENCE="$2"; shift 2 ;; --dir) DIR="$2"; shift 2 ;; --hostname) HOSTNAME_="$2"; shift 2 ;; --build) BUILD="$2"; shift 2 ;; --db-name) DB_NAME="$2"; shift 2 ;; --db-user) DB_USER="$2"; shift 2 ;; --db-pass) DB_PASS="$2"; shift 2 ;; --port) PORT="$2"; shift 2 ;; --name) SVC="$2"; shift 2 ;; --no-start) START=0; shift ;; -h|--help) sed -n '2,25p' "$0"; exit 0 ;; *) echo "unknown option: $1" >&2; exit 1 ;; esac done say() { printf '\n\033[1;34m==\033[0m %s\n' "$*"; } ok() { printf ' \033[32mok\033[0m %s\n' "$*"; } die() { printf '\n\033[31mfailed:\033[0m %s\n' "$*" >&2; exit 1; } [ "$(id -u)" = 0 ] || die "run as root (sudo sh install.sh ...)" [ -f "$SRC/sql/schema.sql" ] || die "run this from a clone of the repository" command -v apt-get >/dev/null || die "this installer is for Debian/Ubuntu" # --- 1. packages ----------------------------------------------------------- say "Installing packages" export DEBIAN_FRONTEND=noninteractive apt-get update -qq apt-get install -y -qq curl ca-certificates wget xz-utils git unzip mariadb-server >/dev/null ok "curl, git, unzip, xz-utils, mariadb-server" # --- 2. FXServer ----------------------------------------------------------- say "Fetching FXServer" if [ -n "$BUILD" ]; then REL=$(curl -fsSL "$ARTIFACTS" | tr '>' '\n' | grep -oE "\./$BUILD-[0-9a-f]+/fx\.tar\.xz" | head -1) [ -n "$REL" ] || die "build $BUILD not found on $ARTIFACTS" else REL=$(curl -fsSL "$ARTIFACTS" | tr '>' '\n' | grep -B4 'LATEST RECOMMENDED' \ | grep -oE '\./[0-9]+-[0-9a-f]+/fx\.tar\.xz' | head -1) [ -n "$REL" ] || die "could not find the recommended build on $ARTIFACTS" fi URL="$ARTIFACTS${REL#./}" BUILD_ID=$(echo "$REL" | grep -oE '[0-9]+' | head -1) mkdir -p "$DIR/server" "$DIR/bin" "$DIR/logs" if [ -x "$DIR/server/run.sh" ] && [ "$(cat "$DIR/server/.build" 2>/dev/null)" = "$BUILD_ID" ]; then ok "build $BUILD_ID already installed" else TMP=$(mktemp -d) curl -fL# "$URL" -o "$TMP/fx.tar.xz" || die "download failed: $URL" rm -rf "$DIR/server"; mkdir -p "$DIR/server" tar xJf "$TMP/fx.tar.xz" -C "$DIR/server" rm -rf "$TMP" chmod +x "$DIR/server/run.sh" echo "$BUILD_ID" > "$DIR/server/.build" ok "build $BUILD_ID unpacked into $DIR/server" fi # --- 3. server-data + oxmysql --------------------------------------------- say "Fetching the base resources" if [ -d "$DIR/server-data/resources" ]; then ok "server-data already present" else git clone --depth=1 -q "$SERVER_DATA_REPO" "$DIR/server-data" || die "could not clone cfx-server-data" ok "cfx-server-data cloned (mapmanager, chat, spawnmanager, sessionmanager, hardcap)" fi if [ -f "$DIR/server-data/resources/[system]/oxmysql/fxmanifest.lua" ]; then ok "oxmysql already present" else TMP=$(mktemp -d) curl -fsSL "$OXMYSQL" -o "$TMP/oxmysql.zip" || die "could not download oxmysql" mkdir -p "$DIR/server-data/resources/[system]" unzip -q -o "$TMP/oxmysql.zip" -d "$TMP" rm -rf "$DIR/server-data/resources/[system]/oxmysql" mv "$(find "$TMP" -maxdepth 2 -name fxmanifest.lua | head -1 | xargs dirname)" \ "$DIR/server-data/resources/[system]/oxmysql" rm -rf "$TMP" ok "oxmysql installed" fi # --- 4. database ----------------------------------------------------------- say "Preparing the database" if [ -d /run/systemd/system ]; then systemctl enable --now mariadb >/dev/null 2>&1 || true else service mariadb start >/dev/null 2>&1 || true fi i=0 while ! mysqladmin ping >/dev/null 2>&1; do i=$((i+1)); [ $i -gt 60 ] && die "mariadb did not start" sleep 1 done if [ -z "$DB_PASS" ]; then if [ -f "$DIR/server-data/server.cfg" ]; then DB_PASS=$(sed -n "s|^set mysql_connection_string \"mysql://[^:]*:\([^@]*\)@.*|\1|p" "$DIR/server-data/server.cfg" | head -1) fi [ -n "$DB_PASS" ] || DB_PASS=$(head -c 24 /dev/urandom | base64 | tr -dc 'A-Za-z0-9' | cut -c1-24) fi mysql -e "CREATE DATABASE IF NOT EXISTS \`$DB_NAME\` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;" mysql -e "CREATE USER IF NOT EXISTS '$DB_USER'@'localhost' IDENTIFIED BY '$DB_PASS';" mysql -e "ALTER USER '$DB_USER'@'localhost' IDENTIFIED BY '$DB_PASS';" mysql -e "GRANT ALL PRIVILEGES ON \`$DB_NAME\`.* TO '$DB_USER'@'localhost'; FLUSH PRIVILEGES;" mysql "$DB_NAME" < "$SRC/sql/schema.sql" ok "database $DB_NAME, user $DB_USER@localhost, schema applied" # --- 5. FiveRP resources and configuration -------------------------------- say "Installing FiveRP" mkdir -p "$DIR/server-data/resources/[local]" for r in fiverp-auth fiverp-characters fiverp-loadscreen; do rm -rf "$DIR/server-data/resources/[local]/$r" cp -r "$SRC/resources/[local]/$r" "$DIR/server-data/resources/[local]/" done ok "fiverp-auth, fiverp-characters, fiverp-loadscreen" cp "$SRC/bin/run-server.sh" "$DIR/bin/" sed "s|/run/fiverp.stdin|/run/$SVC.stdin|" "$SRC/bin/rcon" > "$DIR/bin/rcon" chmod +x "$DIR/bin/run-server.sh" "$DIR/bin/rcon" ln -sf "$DIR/bin/rcon" "/usr/local/bin/$([ "$SVC" = fiverp ] && echo rcon || echo "rcon-$SVC")" CFG="$DIR/server-data/server.cfg" if [ -z "$LICENCE" ] && [ -f "$CFG" ]; then LICENCE=$(sed -n 's/^sv_licenseKey "\(.*\)"$/\1/p' "$CFG" | head -1) fi sed -e "s|0.0.0.0:30120|0.0.0.0:$PORT|g" \ -e "s|^sv_hostname .*|sv_hostname \"$HOSTNAME_\"|" \ -e "s|^sets sv_projectName .*|sets sv_projectName \"$HOSTNAME_\"|" \ -e "s|^sv_licenseKey .*|sv_licenseKey \"${LICENCE:-cfxk_your_key_here}\"|" \ -e "s|^set mysql_connection_string .*|set mysql_connection_string \"mysql://$DB_USER:$DB_PASS@localhost/$DB_NAME?charset=utf8mb4\"|" \ "$SRC/server.cfg.example" > "$CFG" chmod 600 "$CFG" ok "server.cfg written (mode 600 - it holds the key and the password)" # --- 6. boot entry --------------------------------------------------------- say "Setting up start on boot" sed -e "s|^NAME=.*|NAME=$SVC|" -e "s|^DIR=.*|DIR=$DIR|" -e "s|^LOG=.*|LOG=$DIR/logs/server.log|" \ "$SRC/bin/fiverp.init" > "/etc/init.d/$SVC" chmod +x "/etc/init.d/$SVC" if [ -d /run/systemd/system ]; then cat > "/etc/systemd/system/$SVC.service" </dev/null 2>&1 ok "systemd unit $SVC.service" elif [ -d /etc/redl/enabled ]; then # REDL VDS: no systemd, the platform starts whatever is marked here touch "/etc/redl/enabled/$SVC" /etc/redl/enabled/mariadb ok "marked in /etc/redl/enabled (REDL VDS autostart)" else command -v update-rc.d >/dev/null && update-rc.d "$SVC" defaults >/dev/null 2>&1 || true ok "/etc/init.d/$SVC installed" fi # --- 7. start -------------------------------------------------------------- if [ "$START" = 0 ]; then say "Done (not started, --no-start)"; exit 0; fi if [ -z "$LICENCE" ]; then say "Done" echo " No licence key given. Get a free one at https://keymaster.fivem.net," echo " put it into $CFG and run: service $SVC start" exit 0 fi say "Starting the server" if [ -d /run/systemd/system ]; then systemctl restart "$SVC"; else service "$SVC" restart >/dev/null; fi LOG="$DIR/logs/server.log" i=0 while [ $i -lt 90 ]; do if grep -q "Authenticated with cfx.re Nucleus" "$LOG" 2>/dev/null; then ok "server is up and registered with Cfx" grep -q "fiverp-auth\] server ready" "$LOG" && ok "fiverp-auth ready" grep -q "Database server connection established" "$LOG" && ok "oxmysql connected to the database" IP=$(curl -fsS --max-time 5 https://api.ipify.org 2>/dev/null || echo "") printf '\n connect %s:%s\n logs: tail -f %s\n console: rcon status\n\n' "$IP" "$PORT" "$LOG" exit 0 fi if grep -qE "Could not authenticate server license key|invalid license key" "$LOG" 2>/dev/null; then if [ -d /run/systemd/system ]; then systemctl stop "$SVC"; else service "$SVC" stop >/dev/null 2>&1; fi die "the licence key was refused - get one at https://keymaster.fivem.net, put it into $CFG and run: service $SVC start" fi i=$((i+1)); sleep 2 done die "the server did not come up in 3 minutes - see $LOG"