summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2023-08-29 16:30:15 +0000
committerLaurent Bercot <ska@appnovation.com>2023-08-29 16:30:15 +0000
commit0691bcbd11897694a604f99fa58af6b4286c7195 (patch)
treea5259e0b1118c5d294cb4bfb77fa3d25fed4d121 /doc
parente6ada0b74352f77124a682d98c6d842fd5c44b45 (diff)
downloadtipidee-0691bcbd11897694a604f99fa58af6b4286c7195.tar.xz
More examples, some fixes, some more doc
Signed-off-by: Laurent Bercot <ska@appnovation.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/quickstart.html38
1 files changed, 35 insertions, 3 deletions
diff --git a/doc/quickstart.html b/doc/quickstart.html
index 4b369eb..974c4b5 100644
--- a/doc/quickstart.html
+++ b/doc/quickstart.html
@@ -25,16 +25,16 @@
<a href="//skarnet.org/software/s6-networking/">s6-networking</a> installed
alongside tipidee. </li>
<li> Prepare your document root for every virtual domain you aim to serve.
-For instance, if your documents are in <tt>/home/www</tt> and you need to
+For instance, if your documents are in <tt>/home/www/docs</tt> and you need to
serve the <tt>example.com</tt> and <tt>example.org</tt> domains, create
-<tt>/home/www/example.com</tt> and <tt>/home/www/example.org</tt> directories,
+<tt>/home/www/docs/example.com</tt> and <tt>/home/www/docs/example.org</tt> directories,
they will be the document roots for the <tt>example.com</tt> and <tt>example.org</tt>
virtual sites respectively. </li>
<li> Symlink these canonical directories to all the <em>host:port</em> combinations
you want them to be available on. If you want <tt>example.com</tt> and
<tt>example.org</tt> to be both available on ports 80 and 443, then symlink
<tt>example.com</tt> to <tt>example.com:80</tt> and <tt>example.com:443</tt>
-in the <tt>/home/www</tt> directory, and do the same with <tt>example.org</tt>. </li>
+in the <tt>/home/www/docs</tt> directory, and do the same with <tt>example.org</tt>. </li>
<li> Compile a default configuration for tipidee:
<tt>:&gt; /etc/tipidee.conf &amp;&amp; tipidee-config</tt>.
<ul>
@@ -103,5 +103,37 @@ your service manager scripts. </li>
containing service files to run tipidee under various service managers.
</p>
+<div id="faq">
+<h2> Frequently asked questions </h2>
+</div>
+
+<h3> I want my web server to listen to more than one address. Do I need
+to do all that for every address I have? </h3>
+
+<p>
+ Not necessarily: you could listen to <tt>0.0.0.0</tt> for IPv4, and
+<tt>::</tt> for IPv6. But if you don't want your server to listen to
+<em>all</em> the addresses on your machine, then yes, you will have
+to run one process per address:port tuple.
+</p>
+
+<p>
+ It's okay though: every listening process is very small. The skarnet.org
+server has two network cards and runs a web server on both of them, on
+IPv4 and IPv6, over HTTP and HTTPS, which makes 8 services. Plus one
+<a href="//skarnet.org/software/s6/s6-log.html">s6-log</a> logger process
+for each of these services. Plus a supervisor for every service and every
+logger &mdash; for a whooping total of 64 long-running processes just for
+its web server functionality; and it's still not even noticeable, the
+amount of resources it consumes is negligible. So, don't worry about it.
+</p>
+
+<p>
+ Note that this allows you to run different instances of
+<a href="tipideed.html">tipideed</a> with different configurations, if
+you need it. Use the <tt>-f</tt> option to specify a different config
+file for <a href="tipideed.html">tipideed</a>.
+</p>
+
</body>
</html>