176 lines
No EOL
5.7 KiB
HTML
176 lines
No EOL
5.7 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
|
|
<head>
|
|
<title>Docs</title>
|
|
</head>
|
|
|
|
<body>
|
|
<div class="content">
|
|
<div>
|
|
<h2>What is the interverse?</h2>
|
|
<p>
|
|
Interverse is a <a href="https://web0.small-web.org/">web0</a> search engine powered by trust and relationships. <br>
|
|
|
|
</p>
|
|
<h2>What are the Benefits?</h2>
|
|
<ul>
|
|
<li>No databases / cryptocurrency required</li>
|
|
<li>Super scalable!</li>
|
|
<li>Inspired by Web0 / Fediverse</li>
|
|
</ul>
|
|
<h2>Can I get started?</h2>
|
|
<p>You don't need my permission!<br>
|
|
Simply follow the steps and you're online!
|
|
<ol>
|
|
<li>Grab the <a href="interverse-example.json"><u>example file</u></a></li>
|
|
<li>Modify it with your data</li>
|
|
<li>Serve that file from <u>your.website/<strong>.well-known/interverse</strong></u></li>
|
|
<li>Ensure that the webserver also adds the correct header:
|
|
<br><strong>access-control-allow-origin *</strong>
|
|
</li>
|
|
<li>Feel free to test your setup by visiting:<br>
|
|
<u>https://libresolutions.network/Interverse?url=your.website</u></li>
|
|
<li>If you need any help feel free to contact us below.</li>
|
|
|
|
</ol>
|
|
<h2>Widget</h2>
|
|
<p>
|
|
Work in progress. Simply a demonstration of what is possible.
|
|
</p>
|
|
<iframe class="interverse-widget" src="https://libresolutions.network/Interverse?url=gabe.rocks"></iframe>
|
|
|
|
</div>
|
|
|
|
<div>
|
|
<h1 id='spec'>Interverse v0.l</h1>
|
|
<p>The interverse file is the gateway to creating an interconnected trust-based web.</p>
|
|
<p>The file is json formatted but is simply at /.well-known/interverse on your domain/subdomain.</p>
|
|
<br><a href="interverse-example.json"><u>Example file</u></a>
|
|
<h2>Structure</h2>
|
|
<p>Interverse is designed to be extensible, other clients may impliment other features on top.</p>
|
|
|
|
<h2>Fields</h2>
|
|
<h3>name</h3>
|
|
<p>The name of your website (it can be your name, your brand or group)...ect</p>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Mandatory</th>
|
|
<th>Type</th>
|
|
<th>Can be empty</th>
|
|
</tr>
|
|
<tr>
|
|
<td>Yes</td>
|
|
<td>String</td>
|
|
<td>Not enforced</td>
|
|
</tr>
|
|
</table>
|
|
<h3>location</h3>
|
|
<p>This is the location of your website.</p>
|
|
<table>
|
|
<tr>
|
|
<th>Mandatory</th>
|
|
<th>Type</th>
|
|
<th>Can be empty</th>
|
|
</tr>
|
|
<tr>
|
|
<td>Yes</td>
|
|
<td>String (url)</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
</table>
|
|
<h3>image</h3>
|
|
<p>Whatever image you want to use to represent your website</p>
|
|
<table>
|
|
<tr>
|
|
<th>Mandatory</th>
|
|
<th>Type</th>
|
|
<th>Can be empty</th>
|
|
</tr>
|
|
<tr>
|
|
<td>Yes</td>
|
|
<td>String (url)</td>
|
|
<td>Not enforced</td>
|
|
</tr>
|
|
</table>
|
|
<p></p>
|
|
<h3>connections</h3>
|
|
<table>
|
|
<tr>
|
|
<th>Mandatory</th>
|
|
<th>Type</th>
|
|
<th>Can be empty</th>
|
|
</tr>
|
|
<tr>
|
|
<td>Yes</td>
|
|
<td>list (of urls)</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>resources</h3>
|
|
<p>
|
|
This is intended to be for content on your website you speifically want to feature.
|
|
</p>
|
|
<table>
|
|
<tr>
|
|
<th>Mandatory</th>
|
|
<th>Type</th>
|
|
<th>Can be empty</th>
|
|
</tr>
|
|
<tr>
|
|
<td>Yes</td>
|
|
<td>List (resource objects)</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
</table>
|
|
<h4>Object fields:</h4>
|
|
<h5>label</h5>
|
|
<p>Title of the resource</p>
|
|
|
|
<h5>icon</h5>
|
|
<p>Absolute link to a icon for the resource</p>
|
|
|
|
<h5>location</h5>
|
|
<p>the location of the resource (url)</p>
|
|
|
|
<h5>description</h5>
|
|
<p>Describe the resource</p>
|
|
|
|
|
|
<h3>contact</h3>
|
|
<table>
|
|
<tr>
|
|
<th>Mandatory</th>
|
|
<th>Type</th>
|
|
<th>Can be empty</th>
|
|
</tr>
|
|
<tr>
|
|
<td>No</td>
|
|
<td>List (contact)</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
</table>
|
|
<h3>version</h3>
|
|
<table>
|
|
<tr>
|
|
<th>Mandatory</th>
|
|
<th>Type</th>
|
|
<th>Can be empty</th>
|
|
</tr>
|
|
<tr>
|
|
<td>No</td>
|
|
<td>Not enforced</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
<script>
|
|
|
|
</script>
|
|
</body>
|
|
|
|
</html> |