Andrew David Wong
3301c561e7
Merge branch 'policy-api' of https://github.com/pwmarcz/qubes-doc into pwmarcz-policy-api
2020-09-18 01:33:31 -05:00
Bryce Guinta
256b02d0d3
Document use of xl info to find total memory
...
I had to do some digging to figure out why I thought dom0 was reporting an incorrect amount of total memory available, and finally found this command. This document comes up very high in the search results for Qubes memory so I thought I'd put it here since it provides some concrete context to the architecture.
2020-08-29 18:59:09 -04:00
Paweł Marczewski
e7a882a497
Add documentation for policy admin API
2020-08-25 14:43:36 +02:00
WillyPillow
c8d0ee78d5
Add docs for admin.vm.Volume.Clear.
2020-08-10 11:29:11 +08:00
Paweł Marczewski
cc4a4cbf90
admin-api: fix table glitch
...
The `|` needs to be escaped.
2020-03-30 15:48:07 +02:00
Andrew David Wong
6bedebbb77
Merge branch 'policy' of https://github.com/pwmarcz/qubes-doc into pwmarcz-policy
2020-03-18 11:10:48 -05:00
pierwill
9ba79fda5a
Edit qrexec sockets docs
...
Simplify description in "How it works" section and
expand abbreviation for "file descriptor."
2020-03-06 14:28:29 -08:00
pierwill
14fb3fd63a
Add newlines to qrexec socket services docs
2020-03-05 18:03:10 -08:00
Paweł Marczewski
1aacec4ab9
Add documentation for policy internals
...
Describes changes in QubesOS/qubes-core-qrexec#30 .
2020-03-02 14:44:55 +01:00
Paweł Marczewski
1729b078dd
Describe creating a socket-based service
2020-02-28 18:52:00 +01:00
Marek Marczykowski-Górecki
e0d5798105
qrexec: add info the service files needs to be executable
2020-02-24 01:37:53 +01:00
Paweł Marczewski
5eadba0512
qrexec-internals: describe "QUBESRPC ..." command
2020-02-14 11:29:47 +01:00
Paweł Marczewski
b97835c729
qrexec-internals: use MSG_TRIGGER_SERVICE3 name
2020-02-14 11:28:35 +01:00
Paweł Marczewski
38ff5470ce
Rewrite qrexec-internals examples
...
New diagrams (PR: QubesOS/qubes-attachment#30 ).
Add third use case (VM-dom0).
Attempt to make more readable by omitting some details, and
different formatting (less bullet points).
2020-02-11 11:40:55 +01:00
Andrew David Wong
1f8c64fd6e
Merge branch 'import-with-size' of https://github.com/pwmarcz/qubes-doc into pwmarcz-import-with-size
2020-01-23 03:56:59 -06:00
Andrew David Wong
d5470f5a81
Merge branch 'qrexec-internals-further-work' of https://github.com/pierwill/qubes-doc into pierwill-qrexec-internals-further-work
2020-01-23 03:56:09 -06:00
Pawel Marczewski
16ffa0ba76
Document admin.vm.volume.ImportWithSize
...
See QubesOS/qubes-core-admin#309 .
2020-01-20 09:49:21 +01:00
pierwill
53673f00ce
Fix typos
2019-12-27 10:50:34 -08:00
pierwill
5bc91a4bcd
Edit qrexec command line tools descriptions
2019-12-22 14:44:56 -08:00
pierwill
8e12613108
Edit wording of qrexec-client example
2019-12-05 22:29:06 -08:00
pierwill
c967c7b145
Edit qrexec doc page titles
2019-12-05 21:46:49 -08:00
Marek Marczykowski-Górecki
7a46f389ed
Define property.GetAll methods
...
Allow getting all the properties at once, to limit number of Admin API
calls. Client should be prepared to handle the case when the call isn't
available (too old version, refused by the policy etc) and fallback to
getting properties one by one.
2019-12-03 06:22:24 +01:00
pierwill
3246a0ab94
Add paths for qrexec vm tools
2019-11-20 20:52:53 -08:00
pierwill
accb8fe945
Edit qrexec internals docs
2019-10-29 17:54:02 -07:00
pierwill
9b11c6d107
Add diagrams to qrexec internals docs
2019-10-29 17:41:06 -07:00
pierwill
8f53aa8154
Fix paths to qrexec tools
2019-10-12 17:50:18 -07:00
pierwill
b4a28c8261
Revise qrexec internals introduction
2019-10-04 13:25:07 -07:00
pierwill
e4cbcf49e1
Add link to qrexec internals page
2019-10-04 13:25:02 -07:00
pierwill
1514d2e854
Begin revising qrexec internals
...
Add section headings, minor rewordings
2019-09-27 14:50:11 -05:00
pierwill
7c2bb216e1
Revise RPC example and service argument docs
...
- Clarify need for policy files for each desired argument
- Link to USB docs in qrexec policy example
- Fix link to retitled section in release note
2019-08-29 09:27:40 -05:00
pierwill
c8e18dc386
Continue revising RPC service argument example guide
2019-08-26 11:40:02 -05:00
pierwill
863617280d
Reformat code blocks in qrexec.md
...
Use backticks for all code examples in qrexec docs
Also use hyphens for unordered lists
2019-08-26 11:39:41 -05:00
pierwill
a4df3a09e5
Begin revising RPC examples section in qrexec.md
...
- Put both RPC examples under one heading
- Add a table for the needed example policies
2019-08-26 11:38:39 -05:00
pierwill
922f84f9dd
Fix two typos in qrexec.md
2019-08-23 17:08:52 -05:00
pierwill
a4b7b754bb
Fix links to qrexec docs
2019-08-23 16:37:27 -05:00
pierwill
c0a91ca4a9
Revise and edit "Qubes RPC administration" section in qrexec docs
...
Sorts material under three headings.
2019-08-22 16:48:07 -05:00
pierwill
50b38d1161
Make more edits to qrexec docs
...
- Several corrections and rewordings for accuracy
- Fixes leftover outdated '$' keywords
- Remove incomplete list of RPC services
2019-08-18 20:07:16 -05:00
pierwill
b8a53197d3
Add qrexec diagram to qrexec.md
2019-08-18 20:07:16 -05:00
pierwill
6bf95dab39
Edit qrexec-client command line examples
...
- remove absolute paths from qrexec-client calls
- add shell prompt characters
2019-08-18 20:07:16 -05:00
pierwill
5ea1118fa1
Reorder steps in RPC service example
...
Also add a shell prompt character
2019-08-18 20:07:16 -05:00
pierwill
60d60c5ca7
Remove outdated sentence in qrexec doc
2019-08-18 20:07:16 -05:00
pierwill
acf10da436
Revise "Qubes RPC administration" section of qrexec docs
...
- Remove section on "Yes to All" RPC authorization
(and add TODO item for if this feature is reintroduced)
- Replace `$` keywords with `@` in qrexec policy docs
- Incorporate Qubes 4.0 "Extra keywords" material into RPC admin docs
- Move some material to a new section on RPC security concerns
2019-08-18 20:07:16 -05:00
pierwill
57937e97e5
Work definition of term "RPC" into qrexec docs introduction
2019-08-18 20:07:16 -05:00
pierwill
32621ef94f
Split qrexec docs into multiple pages
...
- Moves the "Qubes RPC internals" section to qrexec-internals.md.
- Fixes redirects for new pages.
- Retitles docs to reflect deprecation of qrexec2.
- Revises the texts and links referring to deprecated qrexec2 docs.
2019-08-18 20:07:16 -05:00
pierwill
6476996227
Rewrite toy example of creating a qrexec service
...
Gave the section more structure. Lightly edited the example code.
2019-08-18 20:07:16 -05:00
pierwill
ebf34a6390
Clarify description of qrexec-client example
2019-08-18 20:07:16 -05:00
pierwill
b4550e6c21
Edit RPC services section of qrexec docs
2019-08-18 20:07:16 -05:00
pierwill
c1d2df7ec9
Revise Qubes RPC administration section of qrexec3.md
2019-08-18 20:07:16 -05:00
pierwill
0b6b4bb273
qrexec3.md: remove extra whitespace
2019-08-18 20:07:16 -05:00
pierwill
53e647ca70
Fix lineation in Qubes RPC implementation and protocol details
2019-08-18 20:07:16 -05:00