Skip to content

Commit ee9b4d1

Browse files
committed
docs: add arguments comparison
1 parent 8d8d027 commit ee9b4d1

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

boot.py

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,35 @@
11
#!/usr/bin/env python3
22
# -*- coding: utf-8 -*-
33

4+
"""
5+
Syncplay Bootstrap using to convert redesigned parameter fields into arguments
6+
that are non-intrusive to Syncplay Server.
7+
8+
The official arguments of Syncplay are not convenient for container startup,
9+
especially for file specification scenarios, which can easily confuse people
10+
who use docker.
11+
12+
Document: https://man.archlinux.org/man/extra/syncplay/syncplay-server.1
13+
14+
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
15+
┃ Docker Arguments ┃ Official Arguments ┃
16+
┠───────────────────────────────╂───────────────────────────────────────┨
17+
┃ --motd [MESSAGE] ┃ --motd-file [FILE] ┃
18+
┃ --salt [SALT] & --random-salt ┃ --salt [SALT] ┃
19+
┃ --enable-stats ┃ --stats-db-file [FILE] ┃
20+
┃ --enable-tls ┃ --tls [PATH] ┃
21+
┃ --persistent ┃ --permanent-rooms-file [FILE] ┃
22+
┃ --max-username [NUM] ┃ --max-username-length [NUM] ┃
23+
┃ --max-chat-message [NUM] ┃ --max-chat-message-length [NUM] ┃
24+
┃ --permanent-rooms [ROOM ...] ┃ --permanent-rooms-file [FILE] ┃
25+
┃ --listen-ipv4 [IPv4] ┃ --ipv4-only & --interface-ipv4 [IPv4] ┃
26+
┃ --listen-ipv6 [IPv6] ┃ --ipv6-only & --interface-ipv6 [IPv6] ┃
27+
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┻━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
28+
29+
Through this adapter, you no longer need to create files and specify paths, but
30+
directly configure arguments through the command line or other methods.
31+
"""
32+
433
import os
534
import sys
635
import yaml

0 commit comments

Comments
 (0)