diff options
| author | cel <cel@f/6sQ6d2CMxRUhLpspgGIulDxDCwYD7DzFzPNr7u5AU=.ed25519> | 2019-03-11 15:37:09 -1000 |
|---|---|---|
| committer | cel <cel@f/6sQ6d2CMxRUhLpspgGIulDxDCwYD7DzFzPNr7u5AU=.ed25519> | 2019-03-11 23:11:43 -1000 |
| commit | 36a30d07b0d94709cac2893f718449c34a55d883 (patch) | |
| tree | 7358eeca328c82697d985510af97074275885650 /doc | |
| parent | eba01998e1a0d9172feb30fca0e73c74f4009582 (diff) | |
| download | patchfoo-36a30d07b0d94709cac2893f718449c34a55d883.tar.gz patchfoo-36a30d07b0d94709cac2893f718449c34a55d883.zip | |
Add install guide
&OI38eGVcd3NAwu6F0qMAKXAvrtuLO30EX7Whqc1QBZc=.sha256
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/install-guide.html | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/install-guide.html b/doc/install-guide.html new file mode 100644 index 0000000..961b8db --- /dev/null +++ b/doc/install-guide.html @@ -0,0 +1,72 @@ +<!doctype html> +<html> +<head> +<meta charset=utf-8> +<title>ssb-npm + git-ssb + patchfoo install</title> +<style> +body { + font: 16pt sans-serif; +} +</style> +</head> +<body> +<h2>Installing ssb-npm + git-ssb + patchfoo</h2> +<p>cel 2019-02-25</p> + +<h3>Set up npm</h3> +<p>If you haven't already done so, set a prefix for <code>npm</code> and add its bin directory to your <code>$PATH</code>:</p> +<pre> +echo prefix=$HOME/.local >> ~/.npmrc +echo PATH=\$PATH:$HOME/.local/bin >> ~/.profile +PATH=$PATH:$HOME/.local/bin +</pre> + +<h3>Enable large ssb blobs</h3> +<p>Put into <code>~/.ssb/config</code>:</p> +<pre> +{ + "blobs": { + "max": 10000000 + } +} +</pre> +<p>Restart ssb-server or Patchwork.</p> + +<h3>Install ssb-npm</h3> +<pre> +mkdir -p /tmp/ssb-npm-registry-1.10.2 && cd /tmp/ssb-npm-registry-1.10.2 && +curl -s 'http://localhost:8989/blobs/get/&U7z22fE8SpMiwZMQtUdDvbRUQ9NHTAXdosjzcJD3j/I=.sha256' | tar xz && +./package/bootstrap/bin.js --ws-url http://localhost:8989 \ + --branch %1WiEpn3ymmfO4n7k5Q7V3mIQUO4+v2nlFomxYZhPYyY=.sha256 \ + -- install -g ssb-npm@1.7.1 +</pre> + +<h3>Install git-ssb</h3> +<pre> +ssb-npm install -g git-ssb@2.6.1 \ + --branch %+GtKJu3CCEQlDzGmJbZaGP3yrJCEIvUbvBq3BpuoRmE=.sha256 +</pre> + +<h3>Clone and install patchfoo</h3> + +<h4>As a standalone program (ssb-client):</h4> +<pre> +git clone ssb://%YAg1hicat+2GELjE2QJzDwlAWcx0ML+1sXEdsWwvdt8=.sha256 patchfoo +cd patchfoo +ssb-npm install --branch %SizoOItHdaFQtoDkpX/r4KdOmum7BKEbnE9Rx/UWRAQ=.sha256 +npm start +</pre> + +<h4>or as a sbot plugin:</h4> +<pre> +mkdir ~/.ssb/node_modules +cd ~/.ssb/node_modules +git clone ssb://%YAg1hicat+2GELjE2QJzDwlAWcx0ML+1sXEdsWwvdt8=.sha256 patchfoo +cd patchfoo +ssb-npm install --branch %SizoOItHdaFQtoDkpX/r4KdOmum7BKEbnE9Rx/UWRAQ=.sha256 +sbot plugins.install patchfoo +</pre> +<p>Restart ssb-server or Patchwork.</p> +<p>Visit patchfoo at <a href="http://localhost:8027/">http://localhost:8027/</a>.</p> +</body> +</html> |