hyperboria / docs Goto Github PK

it's hard to find what you're looking for when a single file has a number of translation files listed in a flat namespace.

I propose we come up with a nested structure that makes it easier to look only at the files for a single language.

Files have been named according to quite a few schemes:

• tipsAndTricks.md
• shorewall_and_vpn_gateway_howto.md
• network-services.md

I'm not terribly attached to any of them, but I think they should match.

Once we decide, contributing.md should note which one we expect for pull requests.

This is enough to get us started:

• specify how to ask for help on IRC
  • what OS/Distro are you using?
  • what installation instructions did you follow?
    • provide links or we can't help
  • don't post your privatekey!
  • what commands did you run (exactly)
  • what output leads you to think it didn't work?
• list common issues
  • you used an unsupported installation method
    • outdated .debs or similar
  • you broke your config

Feature: Add Debian Package. Preferably, in the official Debian Repo.
Why?: It currently takes a lot of work to get CJDNS up and running.
I think creating a "one-click-install" would enable access to many more users.

I wasn't sure if this was the place for feature requests, if this is incorrect please tell me.

which would link to static peering credentials, or an open peers endpoint

the front page should link to it from a conspicuous location. It should contain the following details:

1. a list of system-specific install guides for various linux distros (including android and *WRT), OSX/BSDs, and Windows.
2. A section or a link to another document on the syntax and semantics of cjdroute.conf
3. An explanation of current peering procedures:
   • autopeering (generic)
   • Public peers (for hyperboria)
   • and manual UDP peering, with explanations for the difference between IPv4 and IPv6 configuration blocks.

scripts that utilize the admin interface for configuration or runtime inspection are critical for debugging cjdns effectively, yet knowledge of their use seems to be spread primarily by word of mouth.

Let's make their existence more prominent.

At the time it was created it was just a place to dump information that didn't have a home. It's about time we got it sorted out.

Looks like the certificate expired on 2020-08-09.

So fedora.md was reverted to instructions for building cjdns yourself, which is fine, but it should at least mention that cjdns is a system package in Fedora. New users hear about hyperboria, come here and try to follow the instructions (generally get stuck at the "edit cjdns.service" step), and give up.

If they aren't specifically setting out to build it themselves, the docs here are unhelpful. I suggest a brief mention at the top to that effect:

If you are not intending to build cjdns yourself, you are probably better off installing the Fedora system version. "dnf install cjdns cjdns-selinux cjdns-tools" and see README_Fedora.md in /usr/share/docs/cjdns

If you do want to build it yourself, proceed.

I'm going through all the links in this repo and checking if they work with https (c2d7107). In the mean time i've been discovering number of broken links. I'm listing them here for future reference:

I mentioned this in irc.fc00.io chat a few days ago... Instead of developers fiddling with cjdns and other yit yat, I proposed a smooth transition and a real practical use of the Hyperboria network. By installing blockchains and Cryptocurrencies, (big one was the Ethereum Network + ipfs), we can run all the programs, tokens, digital assets on hyperboria. Peers automatically connect through P2P networking in cjdns. This would allow hyperboria to function as a seamless integration mesh network, and the blockchain to be more resistant to censorship. For example, users running solely on cjdns and hyperboria could still make digital transactions. Those using any one of the thousands of Dapps on the Ethereum Blockchain.

I really do see potential for blockchain, as it is now an industry worth over $157.7 Billion and with $5B in transactions every day. If hyperboria is to make a stand in the world as cjd and /r/darknetplan imagined, then it best start playing around with blockchain.

How can you help?
Please, run Major Cryptocurrencies such as Geth Ethereum, bitcoind, and other nodes along with the official go-lang implementation of the ipfs daemon along with anything else that will tickle your fancy. There are so many.... Do which ones you like. If you have mining rigs for any currency, please hook them up to hyperboria. Thanks.

I'm going to add an object to the spec, and label it as an experimental part of the format. anyone who disagrees should voice their opinion in this thread, and we'll revise it as necessary.

Quite a few browsers disable ipv6 support if they cannot detect native IPv6.

There are workarounds, but this issue tends to affect new users more than anyone.

Kudos to @lgierth for the idea.

Looks like your certificate expired in October, so I just wanted to let you know in case you didn't notice yet. 🙂

The current documentation software looks very old. It looks 'scary' for new users and 'troubling'. I recommend switching to a more modern documentation software. Some alternatives that people have recommended to me include Read the Docs, GitBook, MkDocs, BananaDance, and MediaWiki. Our goal should be to create the easiest to use software, starting with the documentation.

I'm trying to test CJDNS and see what is possible with it. But I recently started using another OS and it doesn't work.

Error Log:

@LINUX:/opt/cjdns$ sudo (umask 077 && ./cjdroute --genconf > /etc/cjdroute.conf)
bash: syntax error near unexpected token `umask'
@LINUX:/opt/cjdns$ cp contrib/systemd/cjdns.service /etc/systemd/system/
cp: cannot create regular file '/etc/systemd/system/cjdns.service': Permission denied
@LINUX:/opt/cjdns$ sudo cp contrib/systemd/cjdns.service /etc/systemd/system/
@LINUX:/opt/cjdns$ systemctl enable cjdns
Failed to execute operation: No such file or directory
@LINUX:/opt/cjdns$ systemctl start cjdns
@LINUX:/opt/cjdns$ 

Installation Steps: https://docs.meshwith.me/install/debian-jessie.html

Changes: I had to make some commands root/sudo

OS: Elementary OS

who are we trying to reach? write for them.

At this point, I'm thinking mostly about alpha testers, but we shouldn't make anything to inaccessable.

Many links seem to use .html (which works on the website) and others use .md (which works on github).

I like that it works on github, which makes me wonder if the compiling script running somewhere should be changed to generate .md files instead of .html and have the server configured to serve them as html. Another option would be just redirecting back to github and only display it here.

Thoughts?

This breaks CSP on docs.meshwith.me, and leaks data to github (also requires clearnet connection)

https://github.com/hyperboria/docs/blob/master/cjdns/changelog.md

https://github.com/hyperboria/docs/blob/master/faq/peering.md

Specifically the link to the mesh locals. Due to mesh locals popping in and out of existence I'm not sure this should even be in here anymore. At the same time, I'm not sure where it should be.

@thefinn93 Site out of sync?

https://github.com/hyperboria/docs/blob/master/meshlocals/existing/toronto.md
https://docs.meshwith.me/meshlocals/existing/toronto.html

cc. @juanc1t0

The original content on this site: http://beattheblockade.org/ as linked in the docs. No longer points to where I believe it was intended to point. Just a heads up the site is NSFW, so please don't click on it with children around. - I had to do a quick "whoops!" "Panic close tabs.."

Define all attributes used within the file, link to a JSON spec, and specify where cjdroute.conf differs from conventional JSON.

Please add as resource in your doc: yacy search engine has aleady indexed sites in Hyperboria network:
http://www.hyperborian.org/

Users should be able to start at the front page with zero knowledge, and proceed sequentially, ending with enough knowledge to install, configure, and run cjdroute without assistance.

When i open https://docs.meshwith.me/, I get Connection refused.

As far as I know gitboria has been down for a while, and reviving it isn't a leading priority.

While we don't have to remove all traces of it, we probably shouldn't list it as the canonical repo that users should push to if it isn't accessible.