hyperboria / services Goto Github PK

http://hia.cjdns.ca/test/irc/ircdlist.txt

The readme should be as brief as possible, but give a complete list of the features of the repo in short sections.

• About
  • reasons for this repo
• Howto
  • link to resources for setting up your first service on Hyperboria (these could be internal)
• Policy
  • what you must do to get listed in this repository
• Asking questions
  • where to go, who to contact, etc.
• License
  • If we need this. I am not a lawyer

• title
  • what is the service called.
• operator
  • should this be something else? contact?
• ip
  • an array, since some services (like h.ipfs.io) have two or more ipv6s hosting the content
• description
  • what does the service provide?

Then we need tests to validate entries.

The docs repo has gotten rather large and intimidating.

As it gets periodically merged into the doc folder of cjdns, we should attempt to limit its scope to things which are of immediate concern to a node operator.

There are a lot of topics that are outside of that scope which are still quite relevant to the network. I think we could stand to migrate some of those things here.

Notes about hosting a service on Hyperboria

This includes:

1. a list of common platforms which support ipv6
2. configuration details for such services
   • AAAA records
   • binding to your ipv6
   • :: and other syntax with which people coming from the ipv4 world are familiar
3. privacy concerns
   • what goes into setting up a self-contained service
   • hosting your own fonts, scripts, and other resources

Policy for this repo

See #1

What should be the format on different layers:

• JSON, Lua Tables or ...
• defining schema

...which is online now but I haven't used it:

https://github.com/elimisteve/hyperactive

$ curl -6 -g http://[fcaa:c3ef:7d17:db5a:baca:809b:8376:1e6e]:9999/services

Historically lists of services on Hyperboria have fallen into bad states.

People tend to:

1. join the network
2. launch a service
3. add their service to the list
4. get bored or otherwise unable to maintain their service
5. disappear, but leave their service's address on the list

If we're going to attempt to maintain a list of services on the network, we should set up some means of testing whether they are still active, and some policy for when a service should be removed from the list.