Skip to content

Commit d97c92e

Browse files
committed
Document rpc config until exit-on-server-eof
For: QubesOS/qubes-issues#9176
1 parent 43f49f0 commit d97c92e

File tree

1 file changed

+39
-12
lines changed

1 file changed

+39
-12
lines changed

qubes-rpc-config/README

+39-12
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,52 @@ Configuration syntax:
1919
* String values: must be enclosed by single quotes ('), escape sequences
2020
are unsupported, e.g. 'str'.
2121

22+
* Service types: which kind of services does the configuration option
23+
supports, executables and/or sockets. For socket-based services, see
24+
https://www.qubes-os.org/doc/qrexec-socket-services/
25+
2226
Supported settings:
2327

28+
* exit-on-client-eof:
29+
* Description: Exit when the client shuts down its input stream, client
30+
sends EOF to stdin.
31+
* Conflicting options: if set to 'true', cannot set the 'user' option.
32+
* Service type: socket
33+
* Value type: boolean
34+
* Accepted values: true, false
35+
* Default value: false
36+
* Example: exit-on-client-eof=true
37+
38+
* exit-on-service-eof:
39+
* Description: Exit when the service shuts down its output stream,
40+
service sends EOF to stdout.
41+
* Conflicting options: if set to 'true', cannot set the 'user' option.
42+
* Service type: socket
43+
* Value type: boolean
44+
* Accepted values: true, false
45+
* Default value: false
46+
* Example: exit-on-service-eof=true
47+
2448
* force-user:
2549
* Description: Enforce that service should be run by the specified
2650
username. Useful to set the user at the target qube, which will be
2751
passed directly to PAM without being interpreted by Qrexec, instead of
2852
having to modify the policy in dom0.
53+
* Service type: executable, socket
2954
* Value type: string
3055
* Default value: same user as in the policy, else it is 'user'.
31-
* Example: 'user'
56+
* Example: force-user='user'
57+
58+
* skip-service-descriptor:
59+
* Description: Skip sending service descriptor and go for the actual
60+
data directly. Useful to skip sending metadata to socket-based
61+
services.
62+
* Conflicting options: if set to 'true', cannot set the 'user' option.
63+
* Service type: socket
64+
* Value type: boolean
65+
* Accepted values: true, false.
66+
* Default value: false
67+
* Example: skip-service-descriptor=true
3268

3369
* wait-for-session:
3470
* Description: Wait for full GUI session initialization before starting
@@ -37,18 +73,9 @@ Supported settings:
3773
because there is no GUI running at all), service will never be
3874
started. It is possible for the service to be started even if
3975
qubes.WaitForSession fails, so the service must not depend on setting
40-
"wait-for-session=true" for security.
76+
this option to 'true' for security.
77+
* Service type: executable, socket
4178
* Value type: boolean
4279
* Accepted values: true, false, 0, 1.
4380
* Default value: false
4481
* Example: wait-for-session=true
45-
46-
* skip-service-descriptor:
47-
* Description: Skip sending service descriptor and go for the actual
48-
data directly. Useful to skip sending metadata to socket-based
49-
services, thus the option is valid only for socket services, not
50-
executables. See https://www.qubes-os.org/doc/qrexec-socket-services/
51-
* Value type: boolean
52-
* Accepted values: true, false.
53-
* Default value: false
54-
* Example: skip-service-descriptor=true

0 commit comments

Comments
 (0)