aboutsummaryrefslogtreecommitdiff
path: root/doc/install-guide.html
blob: bd19c7673ed7d78fd4b9127d8fb02947e6402aa1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
<!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; updated 2020-11-27</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 &gt;&gt; ~/.npmrc
echo PATH=\$PATH:$HOME/.local/bin &gt;&gt; ~/.profile
PATH=$PATH:$HOME/.local/bin
</pre>

<h3>Install ssb-npm</h3>
<pre>
npm install -g 'http://localhost:8989/blobs/get/&qcphVNO9k28QT0oASdyjH41XEySuTxX3STooEj+olEE=.sha256'
</pre>

<h3>Install git-ssb</h3>
<pre>
ssb-npm install -g git-ssb@2.8.0 \
  --branch %xlfr8klBuPNiHSXQ5uq2HkrIWudCz9Zzs9jiBoJBz3s=.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 --production --branch %HWJLkLhiapPIaWn2yBOsFIeLNwyrYdSn/Z8cDqiBBi4=.sha256 --branch %eNFBTxGjgxmiQMzNUnHrQqXuBmZ8lwdwlnCbvSG8Rb0=.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 --production --branch %HWJLkLhiapPIaWn2yBOsFIeLNwyrYdSn/Z8cDqiBBi4=.sha256 --branch %eNFBTxGjgxmiQMzNUnHrQqXuBmZ8lwdwlnCbvSG8Rb0=.sha256
node enable-plugin.js
</pre>
<p>Restart ssb-server or Patchwork.</p>
<p>Visit patchfoo at <a href="http://localhost:8027/">http://localhost:8027/</a>.</p>
</body>
</html>