Caleb James DeLisle 8805c3cb4c hax hax hax преди 8 години
..
bugs 3718ba2584 Merge commit '9ef45d9d8fb5b86da848b0ec3da0938c6c9644ff' преди 9 години
cjdns 0fd41a9f2c Fix JSON syntax error (missing comma) преди 9 години
faq 3718ba2584 Merge commit '9ef45d9d8fb5b86da848b0ec3da0938c6c9644ff' преди 9 години
man 36c67d1eb2 docs: remove resetAfterInactivitySeconds, pidFile, version преди 9 години
meshlocals 3718ba2584 Merge commit '9ef45d9d8fb5b86da848b0ec3da0938c6c9644ff' преди 9 години
notes 3718ba2584 Merge commit '9ef45d9d8fb5b86da848b0ec3da0938c6c9644ff' преди 9 години
CjdnsModules.odg 58dac30f83 more work преди 9 години
CjdnsModules.png 8456eb70b6 Added a new flowchart which shows how cjdns now works преди 9 години
README.md c4674a387a Clarified the licensing stuff in /doc/ преди 9 години
Seccomp.md 67034ba897 Messy merge in of master and added seccomp signal handler which explains the problem in a more friendly way преди 10 години
SmartOS.md acc6a5f20c doc: add SmartOS преди 10 години
TrafficAnalisys.md 7d8dbd75fb Revert "doc: remove doc/ in preparation for git subtree-add" преди 9 години
Whitepaper.md b80b648189 Merge branch 'patch-1' of git://github.com/Erkan-Yilmaz/cjdns into crashey преди 9 години
achievements.md 3718ba2584 Merge commit '9ef45d9d8fb5b86da848b0ec3da0938c6c9644ff' преди 9 години
admin-api.md 5ba04c0a7f Fix small typo преди 9 години
autostart-at-login.md d2c025bf11 Add documentation to run as normal user преди 9 години
benchmark.txt f31fc1bb35 Updating the benchmark of pi2 with better gccflags преди 9 години
configure.md 36c67d1eb2 docs: remove resetAfterInactivitySeconds, pidFile, version преди 9 години
ctrls.md 3718ba2584 Merge commit '9ef45d9d8fb5b86da848b0ec3da0938c6c9644ff' преди 9 години
debian-wheezy.md 35cdeaddf3 Add short guide how to install on debian преди 10 години
debugging_memory_leaks.md 7d8dbd75fb Revert "doc: remove doc/ in preparation for git subtree-add" преди 9 години
djc_layer_model.md f106779615 Further defined the next protocol version преди 9 години
eth-hotplug-osx.md 8805c3cb4c hax hax hax преди 8 години
index.md 3718ba2584 Merge commit '9ef45d9d8fb5b86da848b0ec3da0938c6c9644ff' преди 9 години
intro.md 6f658cc4a3 Merge commit '1f62015d7f88eb0eb261df2e38bca34def674004' as 'doc' преди 9 години
nat-gateway.md 5b7e79dbd7 doc: added guide for setting up NAT gateway преди 11 години
network-services.md 4ab2d81e25 documentation on looking at open ports преди 9 години
non-root-user.md d2c025bf11 Add documentation to run as normal user преди 9 години
non-root-user_ru.md 01c27b59f3 Create non-root-user_ru.md преди 9 години
open-indiana.md 9caa52321b doc: factored OpenIndiana install into file преди 11 години
openwrt.md 6f658cc4a3 Merge commit '1f62015d7f88eb0eb261df2e38bca34def674004' as 'doc' преди 9 години
projectGoals.md 335b3d472c Move project goals to its own file and link преди 9 години
projectGoals_ru.md 021c001abb update the russian readme to reflect the changes in english преди 9 години
security_specification.md 6e46fa41f5 Added a definition of what should be able to be expected from cjdns in a security context преди 10 години
shorewall_and_vpn_gateway_howto.md 3718ba2584 Merge commit '9ef45d9d8fb5b86da848b0ec3da0938c6c9644ff' преди 9 години
switchfun.txt 3f7f1c98f6 Documenting how to walk the network using keypings преди 9 години
tipsAndTricks.md 3718ba2584 Merge commit '9ef45d9d8fb5b86da848b0ec3da0938c6c9644ff' преди 9 години
tunnel.md 3718ba2584 Merge commit '9ef45d9d8fb5b86da848b0ec3da0938c6c9644ff' преди 9 години
windows.md 8113d63775 Update windows.md преди 9 години

README.md

Docs

Documenting things related to the meshnet

cjdns addresses a large number of complex issues in an elegant way. While efforts have been made to provide a default configuration that matches the greatest number of use cases, it is impractical to expect software to replace understanding.

Enter the documentation project...

The good citizens of Hyperboria decided to put together this collection of documentation to help make the inner workings of cjdns more transparent.

We want you to get involved! Feel free to submit pull requests.

See index.md for current progress. We'd love more languages!

Also have a look at Prose for Programmers, a work-in-progress book aimed at helping software developers write better prose.

The scope of this project

We are interested in documenting a range of topics:

  1. cjdns internals: bugs and features
  2. operator culture and best practices
  3. meshlocal resources
  4. introductory literature

Reporting bugs

cjd would rather write code than troubleshoot trivial issues which often turn out to have resulted from user error. To make this easier, a few members of the community have offered to investigate issues on his behalf.

If you think you've found a bug, report it on our fork's issue tracker. We'll try to gather up documentation related to the issue, to better understand where it might be coming from. Once we can narrow it down, and research some of the background details to that particular piece of functionality, we may be able to submit patches ourselves.

Anything you can submit that gets us closer to understanding some bug or function within cjdns is welcome. By starting an inquiry, you make it just a little bit easier for someone else to continue it. With that in mind, please read this note on reporting bugs and our more general contribution policy. Get involved!

License

Unless otherwise noted, the documents contained within this /doc/ directory are licensed under a Creative Commons Attribution 4.0 Unported License. By contributing documentation you warrant that you provide it under this license and that you have the right to do so.

See <creativecommons.org/licenses/by/4.0/>

Authors requiring Attribution

If you wish to receive attribution for your work as you are entitled under the CC-BY-SA, please add the name you under which you wish have your work recognized to the following list, if you do not wish to receive specific attribution you may signify this when you contribute by leaving this list as it is.

  • Cjdns Developer Community

For committers

Please remember that the canonical repo is at gitboria.com/projectmeshnet/documentation in Hyperboria. Pull from there, and push there first. If the canonical repo and mirror at github.com/hyperboria/docs diverge, the canonical repo's respective branch shall be force-pushed to the mirror.

Documentation in cjdns.git/doc

This repository is semi-regularly merged into cjdns' doc/ directory. It's useful to ship documentation with the code. We use the following commands.

$ cd cjdns/
$ git remote add hyperboria git@github.com:hyperboria/cjdns.git
$ git remote add docs git@gitboria.com:projectmeshnet/docs.git

To merge documentation changes into cjdns, we squash all new commits since the last merge into one commit, and merge that commit into master.

$ git checkout master
$ git pull hyperboria master
$ git subtree pull --squash -P doc/ docs/master
$ git push hyperboria master

To merge documentation changes in cjdns back upstream into this repository, we create a merge commit, and push it.

$ git subtree split -P doc/
38e3bc6f899de49213aed754c74046b9ae4a85d2
$ git push docs 38e3bc6f:master