add instructions

This commit is contained in:
eyedeekay 2023-11-27 14:02:17 -05:00
parent d7e4b1b60b
commit 892d088356
2 changed files with 53 additions and 0 deletions

30
README_I2P.md Normal file
View file

@ -0,0 +1,30 @@
How to build a Dendrite Homeserver modified to run over I2P
===========================================================
1. First, clone the `matrix-org/dendrite` implementation of dendrite into your GOPATH and change directory to the `main` checkout.
```sh
git clone https://github.com/matrix-org/dendrite $HOME/go/src/github.com/matrix-org/dendrite
cd $HOME/go/src/github.com/matrix-org/dendrite
```
2. Second, add my fork `eyedeekay/dendrite` as a remote and check out the i2p-demo branch.
```sh
git remote add idk https://github.com/eyedeekay/dendrite
git pull idk i2p-demo
git checkout i2p-demo
```
3. Third, build the binary:
```sh
go build -o bin/dendrite-demo-i2p ./cmd/dendrite-demo-i2p
```
Or, do it automatically using just a `curlpipe`
-----------------------------------------------
```sh
curl 'https://eyedeekay.github.io/dendrite/update-branch.sh' | bash -
```

23
index.html Normal file
View file

@ -0,0 +1,23 @@
<h1 id="how-to-build-a-dendrite-homeserver-modified-to-run-over-i2p">How
to build a Dendrite Homeserver modified to run over I2P</h1>
<ol type="1">
<li>First, clone the <code>matrix-org/dendrite</code> implementation of
dendrite into your GOPATH and change directory to the <code>main</code>
checkout.</li>
</ol>
<div class="sourceCode" id="cb1"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> clone https://github.com/matrix-org/dendrite <span class="va">$HOME</span>/go/src/github.com/matrix-org/dendrite</span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="bu">cd</span> <span class="va">$HOME</span>/go/src/github.com/matrix-org/dendrite</span></code></pre></div>
<ol start="2" type="1">
<li>Second, add my fork <code>eyedeekay/dendrite</code> as a remote and
check out the i2p-demo branch.</li>
</ol>
<div class="sourceCode" id="cb2"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> remote add idk https://github.com/eyedeekay/dendrite</span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> pull idk i2p-demo</span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> checkout i2p-demo</span></code></pre></div>
<ol start="3" type="1">
<li>Third, build the binary:</li>
</ol>
<div class="sourceCode" id="cb3"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="ex">go</span> build <span class="at">-o</span> bin/dendrite-demo-i2p ./cmd/dendrite-demo-i2p</span></code></pre></div>
<h2 id="or-do-it-automatically-using-just-a-curlpipe">Or, do it
automatically using just a <code>curlpipe</code></h2>
<div class="sourceCode" id="cb4"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="ex">curl</span> <span class="st">&#39;https://eyedeekay.github.io/dendrite/update-branch.sh&#39;</span> <span class="kw">|</span> <span class="fu">bash</span> <span class="at">-</span></span></code></pre></div>