-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathmmserver.default.toml
183 lines (155 loc) · 7.26 KB
/
mmserver.default.toml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
## Copyright 2024 Colin Marc <[email protected]>
##
## SPDX-License-Identifier: MIT
##
## This file specifies the configuration defaults for the magic mirror server. If
## a line is commented out, the default is to leave the value unset (and the
## setting is not required, unless stated otherwise).
##
## To determine the final config, the server merges the values in this file with
## the provided configuration file (by default, /etc/magic-mirror/mmserver.toml).
##
## All configuration files may be json instead of toml.
## ***-----------------***
## *** Global Settings ***
## ***-----------------***
## If set, this special setting instructs the server to load additional application
## configurations from the given files or directories. Each file (or file in in
## the directories) should be named using the scheme `<NAME>.toml` or
## `<NAME>.json`, where `<NAME>` is the name of the application, following the
## rules outlined below. The contents should be identical to the configuration
## for an individual app.
##
# include_apps = ["/etc/magic-mirror/apps.d"]
## This determines where the server stores application data, i.e. the $HOME for
## containerized applications. If not set, then $XDG_DATA_HOME/mmserver is used,
## or $HOME/.local/share/mmserver if $XDG_DATA_HOME is not set.
##
## If you're running magic-mirror as a permanent daemon, you should set this to
## something like /var/lib/magic-mirror.
##
# data_home = "/var/lib/magic-mirror"
## ***-----------------***
## *** Server Settings ***
## ***-----------------***
##
## This section contains configuration options for the network server.
[server]
## Where the server should listen for incoming connections. IPv6 addresses are
## supported. Use `0.0.0.0` or `[::]` to listen on all available interfaces.
bind = "localhost:9599"
## If set, `bind` will be ignored, and the server will instead listen for
## incoming connections on the socket specified by the LISTEN_FDS environment
## variable. See the systemd documentation on "socket activation", here:
## <https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html>
bind_systemd = false
## Used for TLS. Both are required unless the host portion of the bind address
## resolves to a private address (as defined by RFCs 1918, 4193, and 6598) or
## otherwise not routable, for example `127.0.0.1`, `192.168.24.25`, or
## `fd12:3456:789a:1::1`.
# tls_key = "/path/to/tls.key"
# tls_cert = "/path/to/tls.cert"
## The number of threads to spawn for handling incoming requests.
worker_threads = 8
## The maximum number of concurrent connections the server will accept. Use `inf`
## to specify no limit.
max_connections = 4
## Whether to use mDNS to allow clients to discover the server.
mdns = true
## Determines the FEC (forward error correction) ratio to use for each video
## layer. For example, an array of values ilke `[0.20, 0.10, 0.05]` would use
## 0.20 for the base layer, 0.10 for the second layer, etc. If a layer is not
## covered because the array isn't long enough, the FEC ratio for that layer
## defaults to 0.0. Use an empty array to disable FEC altogether.
##
## If hierarchical coding is not in use, then only the first value applies to
## all video frames.
video_fec_ratios = [0.15]
## The hostname to advertise over mDNS. Defaults to `"$(uname -n).local.` if left
## unset, or ignored if `mdns` is `false`.
# mdns_hostname = "mycomputer.local."
## The instance name to advertise over mDNS. Defaults to the unqualified value of
## `mdns_hostname`, converted to uppercase.
# mdns_instance_name = "MYCOMPUTER"
## ***-------------------------***
## *** Configured Applications ***
## ***-------------------------***
##
## Each application you want to stream must be configured in advance, with each
## application as its own section. Applications can, alternatively, be
## configured as individual files. See the documentation for `include_apps`
## above for more information. At least one application must always be
## configured.
##
## App names must be unique and only contain characters in the set `[a-z0-9-_]`.
## The section is structured as a dictionary, with the key as the application
## name.
##
## An example application configuration follows. (Note that unlike the rest of
## this file, this application is not included in the default configuration.)
# [apps.steam-big-picture]
## A short name for the app.
# description = "Steam"
## The command to run. Must be in `$PATH` or absolute.
# command = ["steam", "-gamepadui"]
## Key/value pairs to set in the environment when running the command.
# environment = { "FOO" = "bar" }
## Configure a "path" for the application. Clients can use this to group apps
## into folders. This has nothing to do with the local filesystem. Paths should
## use unix path separators. They may include characters in the set
## `[A-Za-z0-9-_ ]` (including spaces).
# app_path = "My Games/Puzzle Games"
## Add a header image to the app, for displaying in clients. The image must be a
## PNG file and less than 1mb. Any aspect ratio is permitted, but roughly 2:1
## with a transparent background will work best.
# header_image = "/path/to/image.png"
## Enable XWayland support for this application. This is required for any
## applications that are built for the legacy X11 windowing system, such as Steam.
##
## If unset, defaults to `default_app_settings.xwayland`.
# xwayland = true
## Force the app to run at 1x. This is useful for applications where you know in
## advance they don't support any UI scaling, for example any application run
## through XWayland. This setting will ensure that the app always renders at the
## full session resolution, but may result in small font sizes or other UI
## elements.
##
## If unset, defaults to `default_app_settings.force_1x_scale`.
# force_1x_scale = false
## How long to leave the session running without any client attached to it, in
## seconds. Use the value `inf` to specify no timeout.
# session_timeout = 600
## Isolate the home directory. If set, the application will see a clean,
## sandboxed `$HOME` (and `/home/$(whoami)`), rather than the system-wide one.
## This home directory is saved between runs of the app to
## `<data_home>/homes/<shared_home_name>`.
##
## If unset, defaults to `default_app_settings.isolate_home`.
# isolate_home = true
## If `isolate_home` is set to true, this sets a name for the home directory,
## can be shared between apps. For example, multiple apps with this option set
## to 'myhome' will all see the same $HOME when they run. By default, this is
## set to the name of the application.
##
## If unset, defaults to `default_app_settings.shared_home_name`.
# shared_home_name = same as application name
## If `isolate_home` is set to true, this mounts a brand new $HOME (using tmpfs)
## each time the application is run. If set, `shared_home_name` is ignored.
##
## Note that any data saved while the app is running will be irrevocably
## destroyed when it exits.
##
## If unset, defaults to `default_app_settings.tmp_home`.
# tmp_home = false
## ***----------------------***
## *** Default App Settings ***
## ***----------------------***
##
## This section can be used to set global defaults for all apps. Any setting here
## can be overriden in the configuration for each individual app.
[default_app_settings]
xwayland = true
force_1x_scale = false
session_timeout = 3600 # 1h
isolate_home = true
tmp_home = false