From 35e84d4b5ca923aed2dbd239c5cae4cb06bd96a5 Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Fri, 11 Jun 2010 08:38:52 +0200 Subject: [PATCH] split and expand ceofhack web documentation Signed-off-by: Nico Schottelius --- software/ceofhack.mdwn | 56 +++------------------------- software/ceofhack/build.mdwn | 20 ++++++++++ software/ceofhack/configure.mdwn | 24 ++++++++++++ software/ceofhack/get.mdwn | 35 +++++++++++++++++ software/ceofhack/user.mdwn | 64 ++++++++++++++++++++++++++++++++ 5 files changed, 149 insertions(+), 50 deletions(-) create mode 100644 software/ceofhack/build.mdwn create mode 100644 software/ceofhack/configure.mdwn create mode 100644 software/ceofhack/get.mdwn create mode 100644 software/ceofhack/user.mdwn diff --git a/software/ceofhack.mdwn b/software/ceofhack.mdwn index a9af0bb2..e961c068 100644 --- a/software/ceofhack.mdwn +++ b/software/ceofhack.mdwn @@ -3,67 +3,23 @@ ceofhack is the first implementation of ***EOF*** (Eris Onion Forwarding), the secure, peer-to-peer (p2p), decentralised anonymous chat network. -## How to test ceofhack? - -Simply run the following lines: - - git clone git://git.schottelius.org/EOF/ceofhack - cd ceofhack - ./scripts/init_home.sh - ./ceofhack - -In another terminal, start the ui, as found in **ui-cmd** subfolder. - -## How to get ceofhack? - -### Official releases - - * [[ceofhack-0.6.tar.xz]] - [[EOF-0.6.pdf]] - Usable UI interface - * [[ceofhack-0.5.tar.lzma]] - the first usable version - -### Development - -The latest development code can be found in git. -You can view latest changes in -[gitweb](http://git.schottelius.org/?p=EOF/ceofhack;a=summary) -or clone the latest sources using - - git clone git://git.schottelius.org/EOF/ceofhack - -Git mirrors can be found at - - * [github](http://github.com/telmich/ceofhack/tree/master) - * [gitorious](http://gitorious.org/ceofhack) - -There are (at least) these branches: - - * ***master***: latest "stable" code - * ***hacking***: may not compile, but contains latest ideas - * ***user_interface***: latest work regarding user interfaces - -To submit changes, simply follow the instructions -on [how to setup a public git repo](http://book.git-scm.com/4_setting_up_a_public_repository.html). - -There are also some -[CIA bot statistics](http://cia.vc/stats/project/EOF/ceofhack) available. + * [[user documentationy|user]] ## Support -### Documentation - - * [[The first presentation (in German)|eof-die-erste-vorstellung]] - -### IRC - There are two IRC (!) channels, in which development takes places: * [!eof](irc://IRCNet/!eof) - German * [#cLinux](irc://irc.freenode.org/#cLinux) - Multi language (German/English) -You can also subscribe to the +You can subscribe to the [!eof mailinglist](http://l.schottelius.org/mailman/listinfo/eof). You can also [[contact me directly|about]]. +## Other stuff + + * [[The first presentation (in German)|eof-die-erste-vorstellung]] + [[!tag unix]] diff --git a/software/ceofhack/build.mdwn b/software/ceofhack/build.mdwn new file mode 100644 index 00000000..25bca004 --- /dev/null +++ b/software/ceofhack/build.mdwn @@ -0,0 +1,20 @@ +## Requirements + +ceofhack depends on a small number of other packages: + + * [gpgme](http://www.gnupg.org/gpgme.html) + * make + * [latex](http://www.latex-project.org/) and [dia](http://live.gnome.org/Dia) + (for documentation) + +## Building ceofhack + +Simply run the following line: + + cd ceofhack && make + +Parallel building is also supported, like this: + + cd ceofhack && make -j8 + +[[!tag unix]] diff --git a/software/ceofhack/configure.mdwn b/software/ceofhack/configure.mdwn new file mode 100644 index 00000000..ec16673d --- /dev/null +++ b/software/ceofhack/configure.mdwn @@ -0,0 +1,24 @@ +## Introduction + +ceofhack and all other EOF subsystems need a common place to find themselves +and to function properly. + +## Initial configuration: the easy way + +Simply run the following line: + + cd ceofhack && ./scripts/init_home.sh + +This will + + * create a the configuration directory **$HOME/.ceof**, + * create a new pgp key pair, + * add the tcp transport protool + * and enable the tcp transport protocol to listen to **0.0.0.0:4242**. + +## Initial configuration: the expert way + +Read and understand **./scripts/init_home.sh** and consult +the current EOF standard document. + +[[!tag unix]] diff --git a/software/ceofhack/get.mdwn b/software/ceofhack/get.mdwn new file mode 100644 index 00000000..5bd272da --- /dev/null +++ b/software/ceofhack/get.mdwn @@ -0,0 +1,35 @@ +The current release is [[ceofhack-0.6.tar.xz]], +the current documentation [[EOF-0.6.pdf]]. + +## Development / unreleased code + +The latest development code can be found in git. +You can view latest changes in +[gitweb](http://git.schottelius.org/?p=EOF/ceofhack;a=summary) +or clone the latest sources using + + git clone git://git.schottelius.org/EOF/ceofhack + +Git mirrors can be found at + + * [github](http://github.com/telmich/ceofhack/tree/master) + * [gitorious](http://gitorious.org/ceofhack) + +The ***master*** branch should always contain latest "stable" code, +which means it should at least compile. + +Other branches may be available to focus on specific features, which +will be merged into the master branch after completion. + +To submit changes, simply follow the instructions +on [how to setup a public git repo](http://book.git-scm.com/4_setting_up_a_public_repository.html). + +There are also some +[CIA bot statistics](http://cia.vc/stats/project/EOF/ceofhack) available. + +## All releases + + * [[ceofhack-0.6.tar.xz]] - [[EOF-0.6.pdf]] - Usable UI interface + * [[ceofhack-0.5.tar.lzma]] - the first usable version + +[[!tag unix]] diff --git a/software/ceofhack/user.mdwn b/software/ceofhack/user.mdwn new file mode 100644 index 00000000..f9e2aafb --- /dev/null +++ b/software/ceofhack/user.mdwn @@ -0,0 +1,64 @@ +[[!toc levels=2]] + +## How to get ceofhack running? + +There are three simple steps to get ceofhack running: + + * [[Get ceofhack|get]] + * [[Build ceofhack|build]] + * [[Configure ceofhack|configure]] + +## How to use ceofhack? + +ceofhack is only the main part of an EOF implementation. +ceofhack itself is **not** a user interface (**ui**). +There is, however, a sample command line user interface +included, called **ui_cmd**. Thus, to make real use of +ceofhack, you need to + + * start ceofhack + * and start a user interface + +The following sections explain the ui_cmd user interface, +but the principles are the same for other user interfaces. +All the following examples assume that ceofhack is already +running. + +## How to chat with ceofhack? + +As EOF is a p2p chat network, there's no central server. Thus, you need +to specify where your chat partner ("peer" in EOF speak) can be found. +In ui_cmd you do that with **ui_cmd_peer_add**: + + ./ui_cmd_peer_add telmich tcp:127.0.0.1:4242 A310FB220BA776083559C8276A8817C51B70A5DF + +Where + + * **telmich** is the nickname I gave that peer + * **tcp:127.0.0.1:4242** is the initial address of that peer + * **A310FB220BA776083559C8276A8817C51B70A5DF** is the pgp fingerprint + +### Getting the fingerprints + +You can retrieve all fingerprints known to EOF in a copy & past compatible +format, if you run this command: + + gpg --homedir $HOME/.ceof/gpg --fingerprint | sed 's/ //g' + +### Getting keys + +As the current protocol does not define a key exchange, you need +to manually import pgp keys of other peers. You can do that by dowloading +the public key of the peer to **peer.key** and then running + + gpg --homedir $HOME/.ceof/gpg --import peer.key + + +### Exporting your key + +To allow others to chat with you, you need to publish your public +key somewhere. You can retrieve it the following way: + + gpg --homedir $HOME/.ceof/gpg --export -a > mykey.key + +[[!tag unix]]