HPR/hpr_documentation
6
0
Fork 1
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

Documenting upload and host table

Browse Source
This commit is contained in:
Ken Fallon 2024-12-27 11:27:18 +01:00
parent 2a923dfe69
commit 3ab230d1f3
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
workflow/directory-structure.md
View File

@ -60,19 +60,21 @@ This is currently added manually by the Janitors, as the text to speech tools of
<tr><th>hostid</th><td>Automatically generated incrementing number.</td><td>987</td></tr>
<tr><th>host</th><td>The name or handle of the host.</td><td>Emperor Ming</td></tr>
<tr><th>email</th>The hosts email address with the `@` replaced with `.nospam@nospam.` as an antispam measure<td></td><td>Emperor.Ming.nospam@nospam.example.com</td></tr>
<tr><th>profile</th><td>A html host profile</td><td>`&lt;p&gt;Follow me Mastodon: &lt;a rel=&quot;me&quot; href=&quot;https://mastodon.example.org/@Emperor.Ming&quot;&gt;@Emperor.Ming@mastodon.example.org&lt;/a&gt;&lt;/p&gt;`</td></tr>
<tr><th>license</th><td>One of the allowed licenses</td><td>`CC-BY-SA`</td></tr>
<tr><th>local_image</th><td>If a avatar is available directly from the host.</td><td>`1`</td></tr>
<tr><th>gpg</th><td>We can verify the hosts emails, with [thought to automatically verify](https://repo.anhonesthost.net/HPR/hpr-tools/issues/4).</td><td>`1C7398B00F0239E8`</td></tr>
<tr><th>valid</th><td>Allows temporary de-listing of host</td><td>`0`</td></tr>
<tr><th>profile</th><td>A html host profile</td><td>&lt;p&gt;Follow me Mastodon: &lt;a rel=&quot;me&quot; href=&quot;https://mastodon.example.org/@Emperor.Ming&quot;&gt;@Emperor.Ming@mastodon.example.org&lt;/a&gt;&lt;/p&gt;</td></tr>
<tr><th>license</th><td>One of the allowed licenses</td><td>CC-BY-SA</td></tr>
<tr><th>local_image</th><td>If a avatar is available directly from the host.</td><td>1</td></tr>
<tr><th>gpg</th><td>We can verify the hosts emails, with [thought to automatically verify](https://repo.anhonesthost.net/HPR/hpr-tools/issues/4).</td><td>1C7398B00F0239E8</td></tr>
<tr><th>valid</th><td>Allows temporary de-listing of host</td><td>0</td></tr>
<tr><th>espeak_name</th><td>The text to speech version of the name or handle.</td><td>Fifty One Fifty</td></tr>
<tbody>
</table>
Host Images/Avatars, can either be:
<strong>Local Images</strong> uploaded when the host submits <s>or <a href="https://repo.anhonesthost.net/HPR/hpr_hub/issues/66">edits</a></s> their profile.
<strong>Local Images</strong> uploaded when the host submits or <s><a href="https://repo.anhonesthost.net/HPR/hpr_hub/issues/66">edits</a></s> their profile.
<strong>Gravatar</strong> Images downloaded periodically by the Janitors and copied to the file store on the [origin server](https://en.wikipedia.org/wiki/Upstream_server).
<strong>Default Images</strong> added by [hpr_generator](https://repo.anhonesthost.net/HPR/hpr_generator/src/branch/main/public_html/images/hosts) when the host has no other image.
All the images are [currently](https://repo.anhonesthost.net/HPR/hpr_generator/issues/234) stored in the [hpr_generator](https://repo.anhonesthost.net/HPR/hpr_generator/src/branch/main/public_html/images/hosts) repository, and get transferred to the server using [hpr-publish.bash](https://repo.anhonesthost.net/HPR/hpr-tools/src/branch/main/workflow/hpr-publish.bash).