idk/Hopefully_Holistic_Guide_To_I2P_Dev_Build_Update_Hosting
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Yay it's done.

Browse Source
This commit is contained in:
idk
2022-03-22 13:38:24 -04:00
parent ed70867894
commit e3abea676a
2 changed files with 41 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -333,7 +333,7 @@ newsfeed that informs I2P routers that they need to update, and where to get tho
from. You will need to add this file to your `i2p.newsxml` checkout. A `releases.json` file
contains: the date the torrent was created, the minimum version required to apply the automatic
update, the version that I2P will be updated to, and the download locations. This is a recent
example of an updates.json file:
example of an `releases.json` file:
```json
[
@ -355,5 +355,30 @@ example of an updates.json file:
]
```
Note the `"torrent:"` field, where you should place the generated magnet link you copied from the I2PSnark
Web UI, and the `"url"`
Note the `"torrent:"` field, where you should place the generated magnet link you copied from
the I2PSnark Web UI, and the `"url:"` field, where you should place the download links to your
`.su3` files. When you're done editing your `releases.json` file, copy it to the `./data` directory
corresponding to it's `os`/`branch` in `i2p.newsxml`.
4. Now you should create a news entry for your update. Change directory to your `i2p.newsxml`
checkout, run the command:
```sh
./create_new_entry.sh
```
to automatically start editing a new entry in your custom newsfeed. If you're building for a
specific OS or branch, then set them in the `I2P_OS` and `I2P_BRANCH` environment variables.
Check the code comments or the example below for more custom environment arguments.
```sh
# This is an example of what I would run
TITLE="Update for Windows Jpackage 1.7.0" AUTHOR=idk EDITOR=mousepad I2P_OS=win I2P_BRANCH=beta ./create_new_entry.sh
```
Once you have finished editing, your newsfeed is ready to generate and sign.
5. Now you're ready to build the newsfeed which you will finally be able to use. Return
to the step called "Signing your Update" and repeat those steps with your new feeds. Copy
them over to your news server. Your updates are now ready to distribute. Keep an eye on your
torrent client while the peers go up.

15
index.html
View File

@ -164,7 +164,7 @@
<div class="sourceCode" id="cb25"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb25-1"><a href="#cb25-1" aria-hidden="true"></a><span class="co"># Use this command if you&#39;re using a &quot;User&quot; install or the `.jar` package</span></span>
<span id="cb25-2"><a href="#cb25-2" aria-hidden="true"></a><span class="fu">cp</span> ./i2pupdate.su3 <span class="va">$HOME</span>/.i2p/i2psnark</span></code></pre></div>
<ol start="3" type="1">
<li>Next we need to create the <code>releases.json</code> file which will be used to generate part of our newsfeed that informs I2P routers that they need to update, and where to get those updates from. You will need to add this file to your <code>i2p.newsxml</code> checkout. A <code>releases.json</code> file contains: the date the torrent was created, the minimum version required to apply the automatic update, the version that I2P will be updated to, and the download locations. This is a recent example of an updates.json file:</li>
<li>Next we need to create the <code>releases.json</code> file which will be used to generate part of our newsfeed that informs I2P routers that they need to update, and where to get those updates from. You will need to add this file to your <code>i2p.newsxml</code> checkout. A <code>releases.json</code> file contains: the date the torrent was created, the minimum version required to apply the automatic update, the version that I2P will be updated to, and the download locations. This is a recent example of an <code>releases.json</code> file:</li>
</ol>
<div class="sourceCode" id="cb26"><pre class="sourceCode json"><code class="sourceCode json"><span id="cb26-1"><a href="#cb26-1" aria-hidden="true"></a><span class="ot">[</span></span>
<span id="cb26-2"><a href="#cb26-2" aria-hidden="true"></a> <span class="fu">{</span></span>
@ -183,6 +183,17 @@
<span id="cb26-15"><a href="#cb26-15" aria-hidden="true"></a> <span class="fu">}</span></span>
<span id="cb26-16"><a href="#cb26-16" aria-hidden="true"></a> <span class="fu">}</span></span>
<span id="cb26-17"><a href="#cb26-17" aria-hidden="true"></a><span class="ot">]</span></span></code></pre></div>
<p>Note the <code>"torrent:"</code> field, where you should place the generated magnet link you copied from the I2PSnark Web UI, and the <code>"url"</code></p>
<p>Note the <code>"torrent:"</code> field, where you should place the generated magnet link you copied from the I2PSnark Web UI, and the <code>"url:"</code> field, where you should place the download links to your <code>.su3</code> files. When you’re done editing your <code>releases.json</code> file, copy it to the <code>./data</code> directory corresponding to it’s <code>os</code>/<code>branch</code> in <code>i2p.newsxml</code>.</p>
<ol start="4" type="1">
<li>Now you should create a news entry for your update. Change directory to your <code>i2p.newsxml</code> checkout, run the command:</li>
</ol>
<div class="sourceCode" id="cb27"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb27-1"><a href="#cb27-1" aria-hidden="true"></a><span class="ex">./create_new_entry.sh</span></span></code></pre></div>
<p>to automatically start editing a new entry in your custom newsfeed. If you’re building for a specific OS or branch, then set them in the <code>I2P_OS</code> and <code>I2P_BRANCH</code> environment variables. Check the code comments or the example below for more custom environment arguments.</p>
<div class="sourceCode" id="cb28"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb28-1"><a href="#cb28-1" aria-hidden="true"></a><span class="co"># This is an example of what I would run</span></span>
<span id="cb28-2"><a href="#cb28-2" aria-hidden="true"></a><span class="va">TITLE=</span><span class="st">&quot;Update for Windows Jpackage 1.7.0&quot;</span> <span class="va">AUTHOR=</span>idk <span class="va">EDITOR=</span>mousepad <span class="va">I2P_OS=</span>win <span class="va">I2P_BRANCH=</span>beta <span class="ex">./create_new_entry.sh</span></span></code></pre></div>
<p>Once you have finished editing, your newsfeed is ready to generate and sign.</p>
<ol start="5" type="1">
<li>Now you’re ready to build the newsfeed which you will finally be able to use. Return to the step called “Signing your Update” and repeat those steps with your new feeds. Copy them over to your news server. Your updates are now ready to distribute. Keep an eye on your torrent client while the peers go up.</li>
</ol>
</body>
</html>