/usr/share/doc/ikiwiki-hosting-common/design.html is in ikiwiki-hosting-common 0.20170622ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 | <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>design</title>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="stylesheet" href="style.css" type="text/css" />
<link rel="stylesheet" href="local.css" type="text/css" />
</head>
<body>
<div class="page">
<div class="pageheader">
<div class="header">
<span>
<span class="parentlinks">
<a href="./index.html">ikiwiki hosting internals</a>/
</span>
<span class="title">
design
</span>
</span>
</div>
</div>
<div id="pagebody">
<div id="content" role="main">
<p>Each site has a hostname, which is a subdomain of one of our domains.
For example, foo.branchable.com.</p>
<p>Each site has an owner, which is an openid or email. Typically the admin
is set to the same value as the owner, but a site may have other admins
who do not own it, and it's also possible for its owner not to be an admin
at all.</p>
<p>A site may also have one or more aliases; domain names that CNAME to its
hostname.</p>
<p>The primary url of a site uses either its hostname, or one of its aliases.
Ikiwiki is configured to use this in its url and cgiurl.</p>
<p>From the hostname, a unique <a href="./design/username.html">username</a> is derived. Ikiwiki runs as that user,
and data files associated with the site are stored in the user's home
directory.</p>
<p>Outside the home directory, runtime files for the site are managed in
<code>/var/www/</code>, <code>/var/log/ikiwiki-hosting/</code>, and <a href="./design/apacheconfig.html">apacheconfig</a>.</p>
<p>The home directory has these contents:</p>
<ul>
<li><code>public_html</code> - the site's html is here
(but its cgis are created in /var/www so suidexec can be used)</li>
<li><code>source.git</code> - bare git repo (or similar for other VCS)</li>
<li><code>source</code> - checkout of the wiki's source</li>
<li><code>ikiwiki.setup</code> - config file for the site</li>
<li><code>apache</code> - directory contains optional apache configs
ssl certs, etc)</li>
<li><code>tmp</code> - per-user temp directory</li>
</ul>
<p>The home directory <em>itself</em> is a checkout of a different branch of the
VCS repository, the "setup" branch. Into that branch are checked the
<code>ikiwiki.setup</code> file and other configuration and state files. (But
not ssh keys, htpassword files, etc.) Remote users
may not directly commit to that branch.</p>
<p>The <a href="./ikisite.html">ikisite</a> program handles creating, deleting, and other
administration of these sites.</p>
<p>A <a href="./design/backupformat.html">backupformat</a> encapsulates the above into a single file for backups
and transfer.</p>
<p>A <a href="./design/customersite.html">customersite</a> holds information about customers.</p>
<h2>locking</h2>
<p>ikisite needs to lock sites as it is creating, deleting, or modifying them,
to prevent concurrency issues. This is done using a directory in <code>/var</code>,
the <code>lockdir</code>. The lock files in the lockdir correspond to each site's
username.</p>
</div>
</div>
<div id="footer" class="pagefooter" role="contentinfo">
<div id="pageinfo">
<div id="backlinks">
Links:
<a href="./index.html">index</a>
<a href="./todo/external_hostnames.html">todo/external hostnames</a>
</div>
<div class="pagedate">
Last edited <span class="date">Thu Jun 22 09:08:31 2017</span>
<!-- Created <span class="date">Thu Jun 22 09:08:31 2017</span> -->
</div>
</div>
<!-- from ikiwiki hosting internals -->
</div>
</div>
</body>
</html>
|