subgraph / oz

OZ: a sandboxing system targeting everyday workstation applications
https://subgraph.com/sgos/
Other
432 stars 57 forks source link

Document full Oz profile JSON syntax #114

Open tildelowengrimm opened 7 years ago

tildelowengrimm commented 7 years ago

I can't find any comprehensive documentation for the syntax used for the JSON files in /var/lib/oz/cells.d/. This would be really useful for writing my own Oz configs.

dma commented 7 years ago

The Oz profile is documented here:

https://github.com/subgraph/sgos_handbook

The SGOS handbook should be considered authoritative documentation.

It's mostly complete, I think, at least so far as the major/more mature parameters go. I'll need to re-examine that to make sure it is the case, so I'll leave the issue open.

tildelowengrimm commented 7 years ago

I agree that it'd be great if the specs for Oz profiles were in the handbook. But the documentation there is not quite comprehensive. I've seen plenty of options in the default profiles which aren't documented there, and when trying to write my own it's been trial and error trying to work out what the options are and what they do.

It might also be useful to have a demo config which shows all possible options.