1
Fork 0
mirror of https://github.com/RYGhub/royalnet.git synced 2024-11-23 11:34:18 +00:00

📝 Update sample config

This commit is contained in:
Steffo 2020-09-15 18:51:25 +02:00
parent 732b437bec
commit 012e1afa4f

View file

@ -4,33 +4,24 @@
# Enable the herald module, allowing different parts of Royalnet to talk to each other
# Requires the `herald` extra to be installed
enabled = true
[Herald.Local]
# Run locally a Herald web server (websocket) that other parts of Royalnet can connect to
enabled = true
# Herald can run locally or connect to a remote instance
# "local" = run a local server
# "remote" = connect to a remote
mode = "local"
# The address of the network interface on which the Herald server should listen for connections
# If 0.0.0.0, listen for connections on all interfaces
# If 127.0.0.1, listen only for connections coming from the local machine
address = "0.0.0.0"
# The port on which the Herald server should run
port = 44444
# A password required to connect to the local Herald server
secret = "CHANGE-ME"
# Use HTTPS instead of HTTP for Herald connections
secure = false # Not supported yet!
# Use a different HTTP path for Herald connections
path = "/" # Different values aren't supported yet
[Herald.Remote]
# Connect to a remote Herald web server (websocket)
# Requires the `herald` extra to be installed
enabled = false
# OR
# The address of the remote Herald server
address = "0.0.0.0"
address = "127.0.0.1"
# The port on which the Herald server should run
# OR
# The port of the remote Herald server
port = 44444
# A password required to connect to the local Herald server
# OR
# The password required to connect to the remote Herald server
secret = "CHANGE-ME"
secret = "p4ssw0rd"
# Use HTTPS instead of HTTP for Herald connections
secure = false # Not supported yet!
# Use a different HTTP path for Herald connections
@ -84,17 +75,6 @@ enabled = true
# Obtain one at https://discordapp.com/developers/applications/ > Bot > Token
token = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
[Serfs.Matrix]
# Use the Matrix Serf (matrix-nio) included in Royalnet
# Requires the `matrix` extra to be installed
enabled = true
# The homeserver to login at
homeserver = "https://example.org"
# The full matrix id to login as
matrix_id = "@username:example.org"
# The password of the matrix account to login as
password = "xxxxxxx"
[Logging]
# The output format for the Royalnet logs