ryg/royalnet
ryg/royalnet
1
Fork 0
mirror of https://github.com/RYGhub/royalnet.git synced 2024-11-23 19:44:20 +00:00
Code Activity

📝 Update sample config

Browse source
This commit is contained in:
Steffo 2020-09-15 18:51:25 +02:00
parent 732b437bec
commit 012e1afa4f
1 changed files with 11 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
sample_config.toml
View file

@ -4,33 +4,24 @@
# Enable the herald module, allowing different parts of Royalnet to talk to each other # Enable the herald module, allowing different parts of Royalnet to talk to each other
# Requires the `herald` extra to be installed # Requires the `herald` extra to be installed
enabled = true enabled = true
# Herald can run locally or connect to a remote instance
[Herald.Local] # "local" = run a local server
# Run locally a Herald web server (websocket) that other parts of Royalnet can connect to # "remote" = connect to a remote
enabled = true mode = "local"
# The address of the network interface on which the Herald server should listen for connections # 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 0.0.0.0, listen for connections on all interfaces
# If 127.0.0.1, listen only for connections coming from the local machine # If 127.0.0.1, listen only for connections coming from the local machine
address = "0.0.0.0" # OR
# 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
# The address of the remote Herald server # 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 # The port of the remote Herald server
port = 44444 port = 44444
# A password required to connect to the local Herald server
# OR
# The password required to connect to the remote Herald server # The password required to connect to the remote Herald server
secret = "CHANGE-ME" secret = "p4ssw0rd"
# Use HTTPS instead of HTTP for Herald connections # Use HTTPS instead of HTTP for Herald connections
secure = false # Not supported yet! secure = false # Not supported yet!
# Use a different HTTP path for Herald connections # Use a different HTTP path for Herald connections
@ -84,17 +75,6 @@ enabled = true
# Obtain one at https://discordapp.com/developers/applications/ > Bot > Token # Obtain one at https://discordapp.com/developers/applications/ > Bot > Token
token = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" 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] [Logging]
# The output format for the Royalnet logs # The output format for the Royalnet logs