shithub: web

Download patch

ref: 80c23f5946dda19ef6505d29e5e0ef4a27ed9e22
parent: a71f5e2e548db0d0467ea74bf8a50518ee6f9bda
author: sirjofri <sirjofri@sirjofri.de>
date: Fri Jan 22 07:05:41 EST 2021

adds manual information: mount registry, post new services, cooperate with us with other projects.

--- a/man.ht
+++ b/man.ht
@@ -1,5 +1,42 @@
 <section>
 <header>
-<h2>How to Use our Services</h2>
+<h2>Quickstart</h2>
 </header>
+<p>The public registry is available at:</p>
+<p><strong>tcp!registry.9p.zone!6675</strong></p>
+<p>Use the following commands for mounting:</p>
+<ul>
+<li>9front (using <code>srv</code>): <code>srv tcp!registry.9p.zone!6675 registry /mnt/registry</code></li>
+<li>9front (using <code>9fs</code>): <code>9fs tcp!registry.9p.zone!6675 /mnt/registry</code></li>
+<li>Inferno: <code>mount -A tcp!registry.9p.zone!registry /mnt/registry</code></li>
+</ul>
+
+<h3>Add <code>!registry</code> to Plan 9 systems</h3>
+<p>To use <code>tcp!registry.9p.zone!registry</code> on Plan 9 systems (like on inferno) add the following line to <code>/lib/ndb/common</code>:</p>
+<p><code>tcp=registry port=6675</code></p>
+</section>
+
+<section>
+<header>
+<h2>Add New Services</h2>
+</header>
+<p>You can post new services to the registry using standard methods. For Inferno systems check out the official documentation, since it's a standard Inferno registry. For Plan 9 systems it is possible by writing strings to the <code>new</code> file, like documented in the Inferno manual.</p>
+<p>For Plan 9 systems you can use the following command to post your service:</p>
+<p><code>&gt; /mnt/registry/new {echo 'tcp!yourserver!port description ''your description'' contact you@example.com type fileserver'; while(sleep 3600);}</code>. The <code>while</code> loop is used to keep the file descriptor open. When the file descriptor is closed, the service will be removed from the registry.</p>
+<p>You can integrate this command in your system or add similar behaviour to your applications.</p>
+</section>
+
+<section>
+<header>
+<h2>Promote EXTRA Services</h2>
+</header>
+<p><strong>As we are still focusing on the CORE services we currently can't support all EXTRA services!</strong></p>
+<p>If you want to host your services under the 9p.zone domain see the following checklist and verify that your project fits the description:</p>
+<ul>
+<li>Your project is free (non-profit) to use and publicly available.</li>
+<li>Your project adds value to the public 9p community.</li>
+<li>Your project will exist for a longer period of time.</li>
+<li>You are willing to cooperate with us.</li>
+</ul>
+<p>If all of these points apply to your project, <a href="/legal/">contact us</a> and we can figure out the details together. If we decide your project doesn't fit 9p.zone don't be discouraged! We try to give you details about our decision. It's very likely that we like your project and want to support you by other means.</p>
 </section>
--- a/man.sed
+++ b/man.sed
@@ -1,3 +1,3 @@
 s/%TITLE%/Manual/g
-s/%DESC%/How to Use our Services/g
+s/%DESC%/How to Use our Registry and add other Projects to 9p.zone/g
 s/%PAGETITLE%/How to Use our Services/g