From bbeea90150e2ee4f2295bd7b043803cfd9d24511 Mon Sep 17 00:00:00 2001 From: traumschule Date: Thu, 4 Oct 2018 02:57:43 +0200 Subject: [PATCH] globalist: Improve README intro, document default ControlPort --- globalist/README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/globalist/README.md b/globalist/README.md index ba098cc7a..a0ff6458b 100644 --- a/globalist/README.md +++ b/globalist/README.md @@ -1,16 +1,24 @@ # Globalist -Idea: distributed githubless repository sharing. Yes, this is the official home ;-) +Globalist provides distributed sharing of repositories without the need of central instances (like GitHub). -Globalist is an attempt to ease the distribution of git repos, away from central points of failure. +This is an attempt to ease the distribution of git repos, to overcome the risk of a central points of failure. Globalist stands for "Global List" and aims at replacing any EtherPads of more than transient value. -Globalist is also meant to evolve into an experimental distributed asynchronous wiki facility. +It is also meant to evolve into an experimental distributed asynchronous wiki facility. Nodes can come and go, and network topology only depends on the peers entries in the nodes' config files. Changes that are merged by one's peers propagate by diffusion. +The official repository can be found at https://notabug.org/themusicgod1/cloudflare-tor + ## Usage +To use Globalist.py python3 is needed. Either run it from globalist directory with `python3 Globalist.py` or or install it as described below. + +Per default an open tor ControlPort at 9151 without authentication is expected. You can choose another port with `-C`. For a list of option see `--help`. + +### Create repository + Make a new directory and put this in the file ./repo.cfg (when creating a new repository instead of cloning from a peer, the list or indeed the repo.cfg file can remain empty) ``` @@ -22,6 +30,8 @@ For a public repository, no authentication is needed (option -X). In case authen For each shared repo, Globalist will create one .onion service. Note that it is possible to use either bare repos or not-bare repos. +### Clone a repository + To clone a bare repo: ```