Adding information about yourself on the Pubnix: Difference between revisions

From Project Segfault Wiki
(Created page with "To add information about yourself, that can be displayed in the [https://projectsegfau.lt/pubnix/users /pubnix/users] page, you need to edit the meta-info.env file in your home.<pre> nano ~/meta-info.env <edits> Control+x </pre>The information can also be accessed in json format at <nowiki>https://publapi.p.projectsegfau.lt/users</nowiki>")
 
(Add syntax for meta-info.toml file and examples)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
To add information about yourself, that can be displayed in the [https://projectsegfau.lt/pubnix/users /pubnix/users] page, you need to edit the meta-info.env file in your home.<pre>
To add information about yourself, that can be displayed in the [https://projectsegfau.lt/pubnix/users /pubnix/users] page, you need to edit the <code>meta-info.toml</code> file in your home directory.
nano ~/meta-info.env
 
<edits>
<syntaxhighlight lang="bash">
Control+x
# open nano or your preferred text editor
</pre>The information can also be accessed in json format at <nowiki>https://publapi.p.projectsegfau.lt/users</nowiki>
nano ~/meta-info.toml
 
# edit the file as noted in the syntax section and exit
# (Ctrl+O then Enter to save and Ctrl+X to exit in nano while
# Escape then type ":wq" and hit Enter in Vim)
</syntaxhighlight>
 
The information can also be accessed in JSON format at <code>https://publapi.p.projectsegfau.lt/users</code>. Keep in mind that it takes a few seconds for the text to refresh due to caching.
 
==Syntax==
All fields must be formatted as literal fields.
 
*<code>fullname</code> - Self-explanatory, although if you're not comfortable using your real name due to legal or privacy reasons, you can use a name you go by online or left blank.
*<code>gemini</code> - Defaulting to your gemini webspace in the pubnix, although if you do hosted your gemini website on others (including sourcehut pages) you can just replace it
*<code>website</code> - Defaulting to the [[Host a website on the Pubnix|default pubnix web URL]], but if you're hosting your website somewhere else, just point into it.
*<code>description</code> - Blank by default, plaintext text-only bio of yourself.
*<code>email</code> - Blank by default, but if you're comfortable sharing your email address you can fill in.
*<code>matrix</code> - Blank by default, but if your main Matrix homeserver is in the Project Segfault's servers (via the [[Signup to other services with Pubnix|pubnix Authentik SSO]]) it should be formatted as <code>@user:projectsegfau.lt</code>.
*<code>fediverse</code> - Defaulting to blank, the profile URL of your fediverse profile minus the protocol specifier.
*<code>location</code> - PLEASE DO NOT LEAK YOUR FULL ADDRESS! Defaulting to blank, the location where you're currently residing (<code>in form of City, Province/State, Country</code>)
 
===Example===
<syntaxhighlight lang="toml" line="1">
fullname = "Example User"
gemini = "p.projectsegfau.lt/~user"
website = "https://user.p.projectsegfau.lt"
description = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
email = "user@email.tld"
matrix = "@ajhalili2006:your.homeserver.tld"
fediverse = "your.ap-homeserver.tld"
location = "The Swaggon, Boatem Village, HCS8"
</syntaxhighlight>
[[Category:Pubnix]]

Latest revision as of 15:16, 30 April 2023

To add information about yourself, that can be displayed in the /pubnix/users page, you need to edit the meta-info.toml file in your home directory. 

# open nano or your preferred text editor
nano ~/meta-info.toml

# edit the file as noted in the syntax section and exit
# (Ctrl+O then Enter to save and Ctrl+X to exit in nano while
# Escape then type ":wq" and hit Enter in Vim)

The information can also be accessed in JSON format at https://publapi.p.projectsegfau.lt/users. Keep in mind that it takes a few seconds for the text to refresh due to caching.

Syntax

All fields must be formatted as literal fields.

  • fullname - Self-explanatory, although if you're not comfortable using your real name due to legal or privacy reasons, you can use a name you go by online or left blank.
  • gemini - Defaulting to your gemini webspace in the pubnix, although if you do hosted your gemini website on others (including sourcehut pages) you can just replace it
  • website - Defaulting to the default pubnix web URL, but if you're hosting your website somewhere else, just point into it.
  • description - Blank by default, plaintext text-only bio of yourself.
  • email - Blank by default, but if you're comfortable sharing your email address you can fill in.
  • matrix - Blank by default, but if your main Matrix homeserver is in the Project Segfault's servers (via the pubnix Authentik SSO) it should be formatted as @user:projectsegfau.lt.
  • fediverse - Defaulting to blank, the profile URL of your fediverse profile minus the protocol specifier.
  • location - PLEASE DO NOT LEAK YOUR FULL ADDRESS! Defaulting to blank, the location where you're currently residing (in form of City, Province/State, Country)

Example

fullname = "Example User"
gemini = "p.projectsegfau.lt/~user"
website = "https://user.p.projectsegfau.lt"
description = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
email = "user@email.tld"
matrix = "@ajhalili2006:your.homeserver.tld"
fediverse = "your.ap-homeserver.tld"
location = "The Swaggon, Boatem Village, HCS8"
Retrieved from "https://wiki.projectsegfau.lt/index.php?title=Adding_information_about_yourself_on_the_Pubnix&oldid=219"