Commit Graph

172 Commits

Author SHA1 Message Date
Andrew David Wong
c168714039
Merge branch 'internals' of https://github.com/pwmarcz/qubes-doc into pwmarcz-internals 2020-02-17 04:20:50 -06:00
Marek Marczykowski-Górecki
c254b11a85
GSoC: link one more issue to template manager idea 2020-02-16 21:00:23 +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
Marta Marczykowska-Górecka
6ced25e79b
Updates for GSC 2020
Commented out various obsolete projects, removed one that is genuinely done.
2020-01-30 22:59:42 +01:00
Andrew David Wong
231464a19c
Merge branch 'vmexec' of https://github.com/pwmarcz/qubes-doc into pwmarcz-vmexec 2020-01-26 08:07:23 -06:00
Pawel Marczewski
6563038796
Document qubes.VMExec call
See QubesOS/qubes-issues#4850.
2020-01-24 19:06:20 +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
Andrew David Wong
939995eda9
Merge branch 'patch-5' of https://github.com/mfp20/qubes-doc into mfp20-patch-5 2020-01-19 16:34:39 -06:00
mfp20
3bbf7b91ce
Adds "Notes" chapter
Can be used to include misc notes.
2020-01-16 19:17:04 +01:00
mfp20
272a24843f
Create "Further information" chapter.
And move the lines from the top to this chapter.
In order to give a hook for advanced use and have it in the left side contents menu for easy access.
2020-01-16 18:53:12 +01:00
Elliot Killick
0303f6017d
Fix typos
Format `new` does not exist. Probably meant `newc` as also used later.

Missed a `$` for variable.
2020-01-01 19:16:27 +00: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
Marek Marczykowski-Górecki
12ecfe47f5
Update qubes-builder dependencies: python2-sh -> python3-sh 2019-11-27 04:06:00 +01:00
pierwill
3246a0ab94
Add paths for qrexec vm tools 2019-11-20 20:52:53 -08:00
Andrew David Wong
a64d136eb3
Merge branch 'contrib' of https://github.com/fepitre/qubes-doc into fepitre-contrib 2019-11-14 02:57:23 -06:00
Frédéric Pierret (fepitre)
96069def46
contrib: improvements from Marek's comments 2019-11-11 17:37:12 +01:00
Andrew David Wong
a550680600
Fix typos 2019-11-08 21:27:16 -06:00
Frédéric Pierret (fepitre)
e5bfb48f8d
contrib: improvements from Marek's suggestions 2019-11-08 22:01:59 +01:00
Frédéric Pierret (fepitre)
a8fdfbf9d5
vm-interface: update with respect to GuiVM
Update with Marek's suggestion
2019-11-08 21:32:15 +01:00
Frédéric Pierret (fepitre)
20d8da525b
contrib: precise QCR review procedure 2019-11-08 19:58:10 +01: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
Andrew David Wong
146e256fda
Merge branch 'qrexec-rewrite-phase-3-internals' of https://github.com/pierwill/qubes-doc into pierwill-qrexec-rewrite-phase-3-internals 2019-10-29 00:32:25 -05:00
pierwill
8f53aa8154 Fix paths to qrexec tools 2019-10-12 17:50:18 -07:00
Andrew David Wong
6a4a9ada7d
Improve language 2019-10-04 21:09:45 -05: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
sucrecacao
29d8a44c0a
Made it explicit that we work from dom0 terminal
Confusing because we could be working from a live usb stick
2019-10-04 15:46:39 +00: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
pierwill
e2333b4e76 Remove extra characters in qrexec doc section titles (cosmetic) 2019-08-18 20:07:16 -05:00
pierwill
724b8a32f0 Revise qvm-client command description and examples 2019-08-18 20:07:16 -05:00
pierwill
a2b6838a98 Comment out todo item in qrexec3.md 2019-08-18 20:07:16 -05:00
pierwill
56a9ca2299 Capitalize "RPC" in main text throughout qrexec doc
also capitalizes the term in bash comments, but maintains the string
as in in file paths and other terms
2019-08-18 20:07:16 -05:00
pierwill
4ad035262d Revise "Qrexec basics" section 2019-08-18 20:07:16 -05:00
pierwill
474d15f87e Revise qrexec introduction 2019-08-18 20:07:16 -05:00
pierwill
bdffd0fa59 begin standardizing markdown lineation of qrexec3 docs 2019-08-18 20:07:16 -05:00
Andrew David Wong
35e7f92bc7
Do not strictly require Atx-style headings on both sides
Having the headings on both the left and right sides is more difficult
to edit and maintain, and not much is gained from having them on both
sides. It's still fine to have them on both sides, but this is a
stylistic choice left to the author.
2019-08-09 22:01:50 -05:00
Marek Marczykowski-Górecki
9009c514b9
Update automated tests doc
- python3
- test runner help
- drop some of outdated info
2019-07-30 18:43:58 +02:00
unman
f480010f8b
Clarify inability to use QUBES_REPO for Ubuntu.
General tidy up.
2019-07-01 14:28:29 +00:00
Marek Marczykowski-Górecki
643d02da51
admin-api: add 'list' property type 2019-05-29 23:30:37 +02:00
Marek Marczykowski-Górecki
439b45cd96
admin-api: remove 'draft' note 2019-05-29 23:24:40 +02:00
Andrew David Wong
f441412b7e
Merge branch 'patch-1' of https://github.com/easydozen/qubes-doc into easydozen-patch-1 2019-05-28 21:19:23 -05:00
Andrew David Wong
d31c786942
Reorganize files to account for new "External" section
QubesOS/qubes-issues#4693
2019-05-26 19:32:45 -05:00