index.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4 <meta charset="utf-8">
   5 <meta name="viewport" content="width=device-width, initial-scale=1">
   6 <meta http-equiv="X-UA-Compatible" content="IE=edge">
   7 <link rel="stylesheet" media="all" href="main.css">
   8 <title>The Unleashed Operating System</title>
   9 </head>
  10 <body>
  11 <p class="title">
  12 The Unleashed Operating System
  13 </p>
  14 <p>
  15 Unleashed is an operating system fork of
  16 <a href="https://illumos.org/">illumos</a>, which itself is a derivative of
  17 OpenSolaris and therefore has its roots in UNIX System V Release 4.
  18 </p>
  19 <p>
  20 It is intended as an operating system for <em>developers by developers</em>.
  21 </p>
  22 <p>
  23 Being an illumos-derived OS, Unleashed comes with ZFS, DTrace, and all the
  24 other goodies one would expect.
  25 </p>
  26 <h1>Goals</h1>
  27 <p>
  28 We try to make Unleashed an operating system that <em>we would like to use</em>.
  29 </p>
  30 <p>
  31 While the full list of goals is constantly evolving, the following is a list
  32 of the basic goals which we always strive for.
  33 </p>
  34 <ol>
  35   <li>The contribution process must be simple and must encourage new
  36   contributors to repeatedly contribute.</li>
  37   <li>We aim to have periodic releases (roughly one every 6 months).  Security
  38   patches will be provided between releases.</li>
  39   <li>Unleashed aims to be a modern operating system base.
  40     <ol>
  41       <li>Modern compiler support.  Currently, the base system can only be
  42       built with gcc 4.4.4, however we hope to allow a wider range of gcc
  43       versions.  Eventually, we would like to be able to use clang as
  44       well.</li>
  45       <li>The UNIX environment has changed drastically over the past 20
  46       years.  As a result, we hope to ship an environment that provides the
  47       comforts of modern UNIX, yet maintains the unique features we
  48       inherited that set us apart from other UNIX systems out there.</li>
  49       <li>POSIX has won.  Therefore, when it does not hinder usability (see
  50       item 3.2), we want a system that is POSIX-compliant without having to
  51       jump through special hoops (e.g., setting $PATH, or providing extra
  52       compiler flags).</li>
  53       <li>We do <em>not</em> support &ldquo;extreme legacy&rdquo;.  While
  54       support for legacy interfaces and binaries is important, it must be
  55       done in moderation.  Therefore, old interfaces may be removed from
  56       time to time.  Interface deprecation will be clearly communicated
  57       through release notes.</li>
  58     </ol>
  59   </li>
  60   <li>Maintaining code is hard enough when the code is squeaky clean.  To make
  61    our job easier, we try to get the code clean when first committing it
  62    &mdash; even if it delays the commit a little bit.  In other words, we
  63    care about more than just that the code works &mdash; we want code we can
  64    (for the most part) be proud of.</li>
  65 </ol>
  66 <h1>Download &amp; Installation</h1>
  67 <p>
  68 Please note that <strong>Unleashed is currently not ready for use in a
  69 production environment</strong>.
  70 While we do try to keep up with patches for security vulnerabilities, we do
  71 not have enough resources to make any guarantees.
  72 </p>
  73 <p>
  74 If you wish to build the current master, use the latest available
  75 development snapshot.
  76 </p>
  77 <p>
  78 The only systems currently supported are amd64-based computers and virtual
  79 machines.
  80 </p>
  81 <table>
  82   <tr>
  83     <td>release:</td>
  84     <td><a href="/releases/1.0/">1.0</a></td><td>2018-06-26</td>
  85     <td>[<a href="/releases/1.0/notes.txt">relnotes</a>]</td>
  86     <td>[<a href="/releases/1.0/unleashed-1.0.img.gz">usb</a>]</td>
  87     <td>[<a href="/releases/1.0/unleashed-1.0.iso.gz">iso</a>]</td>
  88     <td>[<a href="/releases/1.0/unleashed-1.0.p5p.gz">p5p</a>]</td>
  89     <td>[<a href="/releases/1.0/checksums">checksums</a>]</td>
  90   </tr>
  91   <tr>
  92     <td>previous rc:</td>
  93     <td><a href="/releases/1.0-rc1/">1.0-rc1</a></td><td>2018-02-12</td>
  94     <td>&nbsp;</td>
  95     <td>&nbsp;</td>
  96     <td>&nbsp;</td>
  97     <td>[<a href="/releases/1.0-rc1/unleashed-1.0-rc1.p5p.gz">p5p</a>]</td>
  98     <td>[<a href="/releases/1.0-rc1/checksums">checksums</a>]</td>
  99   </tr>
 100   <tr>
 101     <td>dev snapshot:</td>
 102     <td><a href="/snapshots/latest/">latest</a></td><td>various</td>
 103     <td>&nbsp;</td>
 104     <td>[<a href="/snapshots/latest/snapshot.img.gz">usb</a>]</td>
 105     <td>[<a href="/snapshots/latest/snapshot.iso.gz">iso</a>]</td>
 106     <td>[<a href="/snapshots/latest/snapshot.p5p.gz">p5p</a>]</td>
 107     <td>[<a href="/snapshots/latest/checksums">checksums</a>]</td>
 108   </tr>
 109 </table>
 110 <h1>IRC &amp; Mailing Lists</h1>
 111 <p>
 112 You can find us in
 113 <a href="ircs://irc.freenode.net:6697/unleashed">#unleashed on Freenode</a>.
 114 </p>
 115 <p>
 116 We have two mailing lists: one for general development discussions
 117 (<a href="http://lists.31bits.net/listinfo/devel">subscribe</a>,
 118 <a href="http://lists.31bits.net/archives/devel/">archives</a>)
 119 and one with commit notifications
 120 (<a href="http://lists.31bits.net/listinfo/commits">subscribe</a>,
 121 <a href="http://lists.31bits.net/archives/commits/">archives</a>).
 122 </p>
 123 <p>
 124 Security sensitive information can be sent to
 125 <a href="mailto:jeffpc@josefsipek.net">jeffpc@josefsipek.net</a>.  If you
 126 wish, you may encrypt your message with PGP
 127 (key ID
 128 <a href="https://sks-keyservers.net/pks/lookup?op=get&search=0x18F90BEB645EB36FE31AEE9F8311B7D703B1E6C8">0x18F90BEB645EB36FE31AEE9F8311B7D703B1E6C8</a>).
 129 </p>
 130 <h1>Contributing</h1>
 131 <p>
 132 We try to make contributing to Unleashed a straightforward affair.
 133 If you have a project in mind or are looking for some suggestions,
 134 contact us on IRC or on the mailing list.
 135 (A good way to come up with a project is to install and use Unleashed.
 136 Anything broken or annoying that you find is a possible project!)
 137 </p>
 138 <p>
 139 The source code itself is split across several git repositories:
 140 </p>
 141 <ul>
 142   <li><a href="http://repo.or.cz/unleashed.git/">core OS</a></li>
 143   <li><a href="http://repo.or.cz/unleashed-userland.git/">userland</a></li>
 144   <li><a href="http://repo.or.cz/unleashed-pkg5.git/">pkg5</a></li>
 145   <li><a href="http://repo.or.cz/unleashed-kayak.git/">kayak installer</a></li>
 146 </ul>
 147 <p>
 148 The steps to build each vary, but they are documented in each repository's
 149 top-level README.
 150 </p>
 151 <h1>Documentation</h1>
 152 <p>
 153 Aside from the typical set of man pages, there is a
 154 <a href="http://repo.or.cz/unleashed.git/tree/HEAD:/docs">docs</a> directory
 155 in the main git repository.
 156 </p>
 157 </body>
 158 </html>
 159