path: root/doc/install/jail.mdwn
diff options
Diffstat (limited to 'doc/install/jail.mdwn')
1 files changed, 53 insertions, 0 deletions
diff --git a/doc/install/jail.mdwn b/doc/install/jail.mdwn
new file mode 100644
index 0000000..50dc8e2
--- /dev/null
+++ b/doc/install/jail.mdwn
@@ -0,0 +1,53 @@
+[[!meta title="Isolated File System Environment Installation"]]
+These instructions explain how to install ProteanOS into a directory on an
+existing host system to run under an isolated file system environment, or
+"jail", using prokit. prokit will run ProteanOS using the **chroot**(2) system
+call via the **chroot**(8) wrapper program.
+It is assumed that you have already
+Note that to run ProteanOS under **chroot**(8) you need a host system running
+Linux 3.4 or later.
+The ProteanOS Development Kit uses the **chroot**(8) and **mount**(8) commands,
+which on Linux require superuser access. This guide assumes the use of
+**sudo**(8) for running commands with superuser privileges. Adjust where
+necessary if you don't use **sudo**(8).
+Installing ProteanOS
+First decide which "suite" of ProteanOS you wish to install. Currently only one
+suite is available: `dev/trunk`.
+Next decide where to install ProteanOS. Replace `$root` below with the path to
+which you want ProteanOS installed.
+If you installed prokit to your system, simply run:
+ $ sudo prokit install dev/trunk $root
+Otherwise, from your prokit build directory, run:
+ $ sudo src/prokit install dev/trunk $root
+Next Steps
+Familiarize yourself with the ProteanOS Development Kit Manual, if you haven't
+already. The **prokit-shell**(8) and **prokit-opkg**(8) commands are used to
+manage installed ProteanOS systems.
+If you'd like to develop packages for ProteanOS, you need to install the
+`build-essential` package (again replacing `prokit` with `src/prokit` if you
+haven't installed prokit):
+ $ sudo prokit opkg $root install build-essential
+This may take a while, depending on your network connection. Then you can start