SYNCPLAY-SERVER(1)

🌸 SYNCPLAY-SERVER 💖

okay bestie so listen — this is the manual page for syncplay-server, a lil program from the General Commands Manual section. It's the server side of the Syncplay situation. Sit down, get a snack, we're doing this. 🍓

✨ NAME ✨

syncplay-server — the server that hosts syncplay rooms, periodt. 👑

🦋 SYNOPSIS 🦋

syncplay-server [options] [file] [playeroptions]

💅 DESCRIPTION 💅

This manual page documents, like, briefly, the syncplay-server command. Brief but iconic.

syncplay-server is the program that syncplay clients connect to — it's the one hosting the rooms. main character energy fr. 🎀

💀 real talk moment: if you wanna host rooms for viewers over the internet, you gotta make sure the server is actually reachable from the internet. Translation: its listening port can't be blocked by a NAT or a firewall. Do the vibe check on your network first, bestie, or nobody's getting in.

🌈 OPTIONS 🌈

This program follows the usual GNU command line syntax, with long options starting with two dashes (-). A summary of options is included below, and yes we're going through every single one because we don't skip. ✨

• -h, --help — shows you a summary of the options. the "help me help you" flag. 🫶
• --port [port] — the TCP port to listen for connections on.
• --password [password] — the server password. keep it cute, keep it secret. 🙈
• --isolate-rooms — whether rooms should be isolated. yes or no, isolated or not.
• --disable-ready — turns off the readiness feature. no more ready-checks, we're just going.
• --disable-chat — turns off the chat function. no yapping in the room, sorry bestie. 😭
• --salt [salt] — a random string used to generate managed room passwords. seasoning, but for security. 🧂✨
• --motd-file [file] — path to a file that the motd (Message Of The Day) gets read from. your lil welcome banner.
• --rooms-db-file [file] — enables room persistence! 🎉 The path points to where a database file should be loaded/created, and room data gets written to and read from it. This enables rooms to persist even without watchers and through restarts. Will not work if using --isolate-rooms. ⚠️
• --permanent-rooms-file [file] — specifies a list of rooms that will still be listed even if their playlist is empty. The path points to a text file with one room per line. This will require persistent rooms to be enabled. 🏠
• --max-chat-message-length [maxChatMessageLength] — max number of characters in one chat message (default is 150).
• --max-username-length [maxUsernameLength] — max number of characters in a username (default is 150).
• --stats-db-file [file] — enables server statistics using the SQLite database file. numbers, but make it a database. 📊
• --tls [path] — enables TLS connections using the certificate files in path. secure the bag. 🔒

👀 SEE ALSO 👀

syncplay(1) — go read that one too, iykyk.

Syncplay Server(1) — February 7 2021 💜

okay that's the whole page, you ate it, go host some rooms bestie, ily, bye! 🦋💖✨