Difference between revisions of "Plugins"

From I2P Wiki
Jump to navigation Jump to search
(add garlic farm)
(updated zzzot and added prometheus plugin)
 
(8 intermediate revisions by 2 users not shown)
Line 6: Line 6:
   
 
<!--T:3-->
 
<!--T:3-->
I2P plugins are stored in ".su3" files (formerly in ".xpi2p" files, but that format is obsolete), and can be installed or uninstalled from the I2P router console.
+
I2P plugins are stored in ".su3" files (formerly in now obsolete ".xpi2p" files), and can be managed from the I2P router console.
   
 
<!--T:4-->
 
<!--T:4-->
Comment by Khanjant, 2016-03-17: "This is the plugin list managed to recover after the epic fall of http://plugins.i2p. Gathered from the plugin list on [http://stats.i2p/i2p/plugins stats.i2p] and [http://temporarypluginlist.i2p/plugins a unofficial temporary list]. I (Khanjant) just started, not finished yet.
+
Comment by Khanjant, 2016-03-17: "This is the plugin list managed to recover after the epic fall of http://plugins.i2p. Gathered from the plugin list on [http://stats.i2p/i2p/plugins stats.i2p] and [http://temporarypluginlist.i2p/plugins a unofficial temporary list]. I (Khanjant) just started, not finished yet."
   
 
<!--T:5-->
 
<!--T:5-->
Because of the sudden shutdown of http://plugins.i2p, some plugins files are still missing to us, if you have some that miss in this list, please contact [[user:Hummingbird]].
+
Because of the sudden shutdown of http://plugins.i2p, some plugins files are still missing. If you have a plugin that is missing here, please contact [[user:Hummingbird|Hummingbird]].
   
 
== Plugin list == <!--T:6-->
 
== Plugin list == <!--T:6-->
Line 21: Line 21:
   
 
<!--T:8-->
 
<!--T:8-->
! Type
 
 
! Plugin name
 
! Plugin name
 
! Type
 
! Latest release (year)
 
! Latest release (year)
 
! URLs (Description / File / Source code)
 
! URLs (Description / File / Source code)
 
! Notes
 
! Notes
 
|-
 
|-
| Tor Helper || ''Blizzard'' || 2021 || http://idk.i2p/blizzard || Adds a Snowflake Proxy to I2P which helps Tor Browser users reach the Tor Network using Pluggable Transports.
+
| ''Blizzard'' || Tor Helper || 2021 || http://idk.i2p/blizzard || Adds a Snowflake Proxy to I2P which helps Tor Browser users reach the Tor Network using Pluggable Transports.
   
 
<!--T:38-->
 
<!--T:38-->
 
|-
 
|-
| Tool for I2P || ''BwSchedule'' || 2015 || [http://y7hb4kzomfzzhekib2mby72ydlntiexmuafuwtlxrxyigtnd63la.b32.i2p/bwschedule_description.html Description by Cacapao (author)] || Bandwidth scheduler for the I2P router
+
| ''BwSchedule'' || Tool for I2P || 2015 || [http://y7hb4kzomfzzhekib2mby72ydlntiexmuafuwtlxrxyigtnd63la.b32.i2p/bwschedule_description.html Description by Cacapao (author)] || Bandwidth scheduler for the I2P router
   
 
<!--T:24-->
 
<!--T:24-->
 
|-
 
|-
| Tool || ''Firefox Search Plugins'' || || [http://direct.i2p/site/webcache/9449449?rId=56eef8a275a82&seq=2 Description (cached page)] ||
+
| ''Firefox Search Plugins'' || Tool || || [http://direct.i2p/site/webcache/9449449?rId=56eef8a275a82&seq=2 Description (cached page)] ||
   
 
<!--T:48-->
 
<!--T:48-->
 
|-
 
|-
| Administration || ''GarlicFarm'' || 2019 || http://zzz.i2p/topics/2234 || Manage massive multihoming with LS2 Meta-leasesets. WIP, development stalled
+
| ''GarlicFarm'' || Administration || 2019 || http://zzz.i2p/topics/2234 || Manage massive multihoming with LS2 Meta-leasesets. WIP, development stalled
 
<!--T:22-->
 
|-
 
| Email || ''[[I2P-Bote]]'' || 2018 || [[I2P-Bote#To_get_it|Description, file]] || Unsupported, obsolete, does not support signature types, needs developer
 
   
 
<!--T:23-->
 
<!--T:23-->
 
|-
 
|-
| File sharing || ''[[I2Phex]]'' || 2016 || [http://stats.i2p/i2p/plugins/ Plugin] || Also available as standalone software<ref>I2Phex v3.2.7 standalone available from http://echelon.i2p/i2phex/</ref>
+
| ''[[I2Phex]]'' || File sharing || 2016 || [http://stats.i2p/i2p/plugins/ Plugin] || Also available as standalone software<ref>I2Phex v3.2.7 standalone available from http://echelon.i2p/i2phex/</ref>
   
 
<!--T:45-->
 
<!--T:45-->
 
|-
 
|-
| File sharing || ''i2psnark-rpc'' || 2020 || http://zzz.i2p/topics/2941 || Remote control of i2psnark using the Transmission RPC protocol
+
| ''i2psnark-rpc'' || File sharing || 2020 || http://zzz.i2p/topics/2941 || Remote control of i2psnark using the Transmission RPC protocol
   
 
<!--T:26-->
 
<!--T:26-->
 
|-
 
|-
| IRC client || ''[[JIRCii|jIRCii]]'' || 2016<ref>http://zzz.i2p/topics/2162-jircii-2014-12-9-z1</ref> || [http://stats.i2p/i2p/plugins/jIRCii.xpi2p File on stats.i2p], File from iMule (v0.9.0, 2011)<ref>ed2k://|file|jIRCii.xpi2p|319207|E08E77D0B9A76455C6EA55C0C1E3A477|h=V5S4ZMFRPWNLHEMY7EDIWDEYU33EGUU6|/</ref> || jIRCii as a plugin for the I2P console, written in Java. [http://www.oldschoolirc.com Official website (clearnet, not I2P compatible)].
+
| ''[[JIRCii|jIRCii]]'' || IRC client || 2016<ref>http://zzz.i2p/topics/2162-jircii-2014-12-9-z1</ref> || [http://stats.i2p/i2p/plugins/jIRCii.xpi2p File on stats.i2p], File from iMule (v0.9.0, 2011)<ref>ed2k://|file|jIRCii.xpi2p|319207|E08E77D0B9A76455C6EA55C0C1E3A477|h=V5S4ZMFRPWNLHEMY7EDIWDEYU33EGUU6|/</ref> || jIRCii as a plugin for the I2P console, written in Java. [http://www.oldschoolirc.com Official website (clearnet, not I2P compatible)].
   
 
<!--T:27-->
 
<!--T:27-->
 
|-
 
|-
| Tool for I2P<ref>"Julya is a network enabled Jython shell, allowing multiple instances of Jython to be managed from a network connection. Jython scripts can be run in a headless environment by sending scripts via TCP connections defined by the user."</ref> || ''Julya'' || 2014 || [http://git.repo.i2p/w/jython_i2p_api.git Homepage and source code] ||
+
| ''Julya''<ref>"Julya is a network enabled Jython shell, allowing multiple instances of Jython to be managed from a network connection. Jython scripts can be run in a headless environment by sending scripts via TCP connections defined by the user."</ref> || Tool for I2P || 2014 || [http://git.repo.i2p/w/jython_i2p_api.git Homepage and source code] ||
   
 
<!--T:28-->
 
<!--T:28-->
 
|-
 
|-
| Tool for [[I2Phex]] || ''[[Jwebcache]]'' || 2016 || [http://stats.i2p/i2p/plugins/ File] or [http://echelon.i2p/jwebcache/ File] ||
+
| ''[[Jwebcache]]'' || Tool for [[I2Phex]] || 2016 || [http://stats.i2p/i2p/plugins/ File] or [http://echelon.i2p/jwebcache/ File] ||
   
 
<!--T:29-->
 
<!--T:29-->
 
|-
 
|-
| HTTP outproxy || ''Outertubes'' || 2012 ? || Description<ref>"Outertubes ia an HTTP Outproxy. It allows other I2P users to connect to the regular Internet via your machine." from http://archiv.tutorials.i2p/i2p-plugins/outertubes/</ref> (coded by HungryHobbo<ref>http://zzz.i2p/topics/1149</ref>) ||
+
| ''Outertubes'' || HTTP outproxy || 2012 ? || Description<ref>"Outertubes ia an HTTP Outproxy. It allows other I2P users to connect to the regular Internet via your machine." from http://archiv.tutorials.i2p/i2p-plugins/outertubes/</ref> (coded by HungryHobbo<ref>http://zzz.i2p/topics/1149</ref>) ||
   
 
<!--T:39-->
 
<!--T:39-->
 
|-
 
|-
| Blog || ''Railroad'' || 2021 || http://idk.i2p/railroad || Easy to setup single-user blog which is compatible with Ghost themes.
+
| ''Railroad'' || Blog || 2021 || http://idk.i2p/railroad || Easy to setup single-user blog which is compatible with Ghost themes.
   
 
<!--T:37-->
 
<!--T:37-->
 
|-
 
|-
| Reseed || ''Reseed-tools'' || 2021 || http://idk.i2p/reseed-tools || Easy to setup I2P Reseed server in Go, also available as standalone software.
+
| ''Reseed-tools'' || Reseed || 2021 || http://idk.i2p/reseed-tools || Easy to setup I2P Reseed server in Go, also available as standalone software.
   
 
<!--T:46-->
 
<!--T:46-->
 
|-
 
|-
| Demo plugin || ''servlet3'' || 2019 || http://zzz.i2p/forums/16 || Test of servlet 3.0 features
+
| ''servlet3'' || Demo plugin || 2019 || http://zzz.i2p/forums/16 || Test of servlet 3.0 features
   
 
<!--T:21-->
 
<!--T:21-->
 
|-
 
|-
| Demo plugin || ''Snowman'' || 2015 || [http://stats.i2p/i2p/plugins/snowman.xpi2p File]. [http://stats.i2p/i2p/plugins/i2p.snowman.zip Source code] || Just a little test, creates a single-page webapp. The plugin contains some commented config files that may be helpful for plugin developers.
+
| ''Snowman'' || Demo plugin || 2015 || [http://stats.i2p/i2p/plugins/snowman.xpi2p File]. [http://stats.i2p/i2p/plugins/i2p.snowman.zip Source code] || Just a little test, creates a single-page webapp. The plugin contains some commented config files that may be helpful for plugin developers.
   
 
<!--T:47-->
 
<!--T:47-->
 
|-
 
|-
| HTTP Outproxy || ''socksoutproxy'' || 2022 || http://zzz.i2p/topics/3219 || Routes outproxy traffic to a local running Tor instance
+
| ''socksoutproxy'' || HTTP Outproxy || 2022 || http://zzz.i2p/topics/3219 || Routes outproxy traffic to a SOCKS5 proxy (useful for redirecting to a running Tor instance)
   
 
<!--T:34-->
 
<!--T:34-->
 
|-
 
|-
| Forums || ''[[Syndie]]'' || 2016 || || Also available as standalone software
+
| ''[[Syndie]]'' || Forums || 2016 || || Also available as standalone software
   
 
<!--T:35-->
 
<!--T:35-->
 
|-
 
|-
| Tool for [[Tahoe-LAFS]] || ''Tahoe-LAFS Controller'' || 2010 || [http://stats.i2p/i2p/plugins/tahoe-lafs-controller.xpi2p File (on stats.i2p)] ||
+
| ''Tahoe-LAFS Controller'' || Tool for [[Tahoe-LAFS]] || 2010 || [http://stats.i2p/i2p/plugins/tahoe-lafs-controller.xpi2p File (on stats.i2p)] ||
   
 
<!--T:40-->
 
<!--T:40-->
 
|-
 
|-
| IRC Server || ''Terrarium'' || 2021 || http://idk.i2p/terrarium || Terrarium makes it easy to set up IRC networks on I2P.
+
| ''Terrarium'' || IRC Server || 2021 || http://idk.i2p/terrarium || Terrarium makes it easy to set up IRC networks on I2P.
   
 
<!--T:36-->
 
<!--T:36-->
 
|-
 
|-
| BitTorrent tracker || ''ZzzOT'' || 2020<ref>0.14.0-b1 released in 2015</ref> || [http://stats.i2p/i2p/plugins/zzzot.su3 File (on stats.i2p)]<ref>After installation, a brief help page will be available at http://127.0.0.1:7662/help.html. Be sure to read it completely!</ref>|| A Java BitTorrent Opentracker. Has no eepsite, but a official forum (zzz.i2p)<ref>http://zzz.i2p/search?type=topics&query=zzzot&commit=Search</ref>
+
| ''zzzOT'' || BitTorrent tracker || 2024<ref>0.19.0-b1 released in 2015</ref> || [http://stats.i2p/i2p/plugins/zzzot.su3 File (on stats.i2p)]<ref>After installation, a brief help page will be available at http://127.0.0.1:7662/help.html. Be sure to read it completely!</ref>|| A Java BitTorrent Opentracker. Has no eepsite, but a official forum (zzz.i2p)<ref>http://zzz.i2p/search?type=topics&query=zzzot&commit=Search</ref>
   
  +
<!--T:50-->
 
|-
  +
| ''prometheus'' || Tool for prometheus || 2025<ref>0.4-b1 released in 2025</ref> || [http://stats.i2p/i2p/plugins/prometheus.su3 File (on stats.i2p)]<ref>See readme for prometheus server configuration. </ref> || Exports stats to a prometheus metrics server.
  +
  +
<!--T:49-->
  +
|-
  +
| ''Tor Browser Manager'' || Browser Configuration || 2022 || http://idk.i2p/i2p.plugins.tor-manager || Manages a Tor Browser instance and functions as a combined Tor/I2P browser.
   
 
|}
 
|}
Line 120: Line 123:
 
* ''Neodatis'' File: [http://sponge.i2p/files/seedless/01_neodatis.xpi2p on sponge.i2p (official)] or [http://stats.i2p/i2p/plugins/others/Seedless/ on stats.i2p] Used by [[Seedless]] which is unsupported and obsolete
 
* ''Neodatis'' File: [http://sponge.i2p/files/seedless/01_neodatis.xpi2p on sponge.i2p (official)] or [http://stats.i2p/i2p/plugins/others/Seedless/ on stats.i2p] Used by [[Seedless]] which is unsupported and obsolete
 
<!--T:31-->
 
<!--T:31-->
* ''[[Orchid|Orchid]]-zzz'' [http://stats.i2p/i2p/plugins/ (plugin website)] 'Orchid is a Tor client implementation and library written in pure Java.'<ref>https://subgraph.com/orchid/</ref> Obsolete, supports v2 onion only
 
 
<!--T:32-->
 
<!--T:32-->
* ''[[Orchid]]-thebland'' [http://thebland.i2p/i2p/plugins/ (plugin website)] [http://zzz.i2p/topics/2031?page=1#p11363 (How to install)] || 'Orchid is a Tor client implementation and library written in pure Java.'<ref>https://subgraph.com/orchid/</ref> Obsolete, supports v2 onion only
+
* ''[[Orchid]] ([http://stats.i2p/i2p/plugins/ zzz's version], [http://thebland.i2p/i2p/plugins/ thebland's version] ([http://zzz.i2p/topics/2031?page=1#p11363 how to install])) 'Orchid is a Tor client implementation and library written in pure Java.'<ref>https://subgraph.com/orchid/</ref> Plugins obsolete (supports v2 onion only) and actual thing seems to be dead
 
<!--T:40-->
 
<!--T:40-->
 
* '''Pebble''': "a lightweight, open source, Java EE blogging tool".<ref>http://direct.i2p/site/webcache/9450470?rId=56ef019684452&seq=2</ref>
 
* '''Pebble''': "a lightweight, open source, Java EE blogging tool".<ref>http://direct.i2p/site/webcache/9450470?rId=56ef019684452&seq=2</ref>
 
<!--T:33-->
 
<!--T:33-->
 
* ''[[Seedless]]'' [http://sponge.i2p/files/seedless/doc/how-to-seedless.html Description (on sponge.i2p)]. File: [http://sponge.i2p/files/seedless/02_seedless.xpi2p On sponge.i2p (official)] or [http://stats.i2p/i2p/plugins/others/Seedless/ on stats.i2p]<ref>http://zzz.i2p/topics/2267-lost-plugin-directory</ref> (read the article [[Seedless]] before to install !). Unsupported, obsolete
 
* ''[[Seedless]]'' [http://sponge.i2p/files/seedless/doc/how-to-seedless.html Description (on sponge.i2p)]. File: [http://sponge.i2p/files/seedless/02_seedless.xpi2p On sponge.i2p (official)] or [http://stats.i2p/i2p/plugins/others/Seedless/ on stats.i2p]<ref>http://zzz.i2p/topics/2267-lost-plugin-directory</ref> (read the article [[Seedless]] before to install !). Unsupported, obsolete
 
<!--T:22-->
 
* ''[[I2P-Bote]]'': [[I2P-Bote#To_get_it|Description, file]] "I2P-Bote is an end-to-end encrypted, network-internal, fully decentralized (serverless) e-mail system" Unsupported, obsolete<ref>http://zzz.i2p/topics/2853-rip-bote</ref>, does not support signature types, needs developer
   
 
== FAQ == <!--T:10-->
 
== FAQ == <!--T:10-->
Line 166: Line 170:
   
 
<!--T:18-->
 
<!--T:18-->
Those looking to create new plugins for I2P might want to look at the [http://i2p-projekt.i2p/en/docs/plugins introduction to plugin development], the [http://i2p-projekt.i2p/en/docs/spec/plugin plugin specification], and the [http://zzz.i2p plugin forum].
+
Those looking to create new plugins for I2P might want to look at the [http://i2p-projekt.i2p/en/docs/plugins introduction to plugin development], the [http://i2p-projekt.i2p/en/docs/spec/plugin plugin specification], and the [http://zzz.i2p development forum (zzz.i2p)].
   
 
== References == <!--T:19-->
 
== References == <!--T:19-->

Latest revision as of 16:36, 25 June 2025

Introduction

This page is about plugins designed for the I2P router console.

I2P plugins are both a means to extend I2P's router functionality as well as a method of packaging things.

I2P plugins are stored in ".su3" files (formerly in now obsolete ".xpi2p" files), and can be managed from the I2P router console.

Comment by Khanjant, 2016-03-17: "This is the plugin list managed to recover after the epic fall of http://plugins.i2p. Gathered from the plugin list on stats.i2p and a unofficial temporary list. I (Khanjant) just started, not finished yet."

Because of the sudden shutdown of http://plugins.i2p, some plugins files are still missing. If you have a plugin that is missing here, please contact Hummingbird.

Plugin list

Non-obsolete

Plugin name Type Latest release (year) URLs (Description / File / Source code) Notes
Blizzard Tor Helper 2021 http://idk.i2p/blizzard Adds a Snowflake Proxy to I2P which helps Tor Browser users reach the Tor Network using Pluggable Transports.
BwSchedule Tool for I2P 2015 Description by Cacapao (author) Bandwidth scheduler for the I2P router
Firefox Search Plugins Tool Description (cached page)
GarlicFarm Administration 2019 http://zzz.i2p/topics/2234 Manage massive multihoming with LS2 Meta-leasesets. WIP, development stalled
I2Phex File sharing 2016 Plugin Also available as standalone software[1]
i2psnark-rpc File sharing 2020 http://zzz.i2p/topics/2941 Remote control of i2psnark using the Transmission RPC protocol
jIRCii IRC client 2016[2] File on stats.i2p, File from iMule (v0.9.0, 2011)[3] jIRCii as a plugin for the I2P console, written in Java. Official website (clearnet, not I2P compatible).
Julya[4] Tool for I2P 2014 Homepage and source code
Jwebcache Tool for I2Phex 2016 File or File
Outertubes HTTP outproxy 2012 ? Description[5] (coded by HungryHobbo[6])
Railroad Blog 2021 http://idk.i2p/railroad Easy to setup single-user blog which is compatible with Ghost themes.
Reseed-tools Reseed 2021 http://idk.i2p/reseed-tools Easy to setup I2P Reseed server in Go, also available as standalone software.
servlet3 Demo plugin 2019 http://zzz.i2p/forums/16 Test of servlet 3.0 features
Snowman Demo plugin 2015 File. Source code Just a little test, creates a single-page webapp. The plugin contains some commented config files that may be helpful for plugin developers.
socksoutproxy HTTP Outproxy 2022 http://zzz.i2p/topics/3219 Routes outproxy traffic to a SOCKS5 proxy (useful for redirecting to a running Tor instance)
Syndie Forums 2016 Also available as standalone software
Tahoe-LAFS Controller Tool for Tahoe-LAFS 2010 File (on stats.i2p)
Terrarium IRC Server 2021 http://idk.i2p/terrarium Terrarium makes it easy to set up IRC networks on I2P.
zzzOT BitTorrent tracker 2024[7] File (on stats.i2p)[8] A Java BitTorrent Opentracker. Has no eepsite, but a official forum (zzz.i2p)[9]
prometheus Tool for prometheus 2025[10] File (on stats.i2p)[11] Exports stats to a prometheus metrics server.
Tor Browser Manager Browser Configuration 2022 http://idk.i2p/i2p.plugins.tor-manager Manages a Tor Browser instance and functions as a combined Tor/I2P browser.

Obsolete

FAQ

Does the plugin version always match with the latest standalone version?

Not always. Sometimes the plugin version is outdated: the standalone version of the software is more recent. If this case, you should use the standalone version.

How to install a plugin?

Usually, the process is as follows:

  1. Go to the plugin page in your I2P router console: 'I2P Services' > 'Clients' > 'Plugins' (or click this URL: http://127.0.0.1:7657/configplugins)
  2. If you have the URL to the plugin file: at the bottom of the page, look for the box 'Installation from URL.' Paste inside the URL to the plugin file (example: http://bote.i2p/i2pbote.su3)
  3. If you have the plugin file on your HDD: at the bottom of the page, look for the box 'Installation from File' and browse to the location of the file.
  4. Click the button 'Install Plugin' (or 'Install Plugin from file')
  5. Wait several minutes
  6. Once installed, you will see a new text string at the top of the router console, below 'I2P Services'

Note: you should read the description page of the plugin, because there is perhaps more setup to do.

How to check the signature of a plugin file manually, before installing it

Usually, this isn't needed. The I2P router plugin installer automatically checks whether the signature of the downloaded .su3 file is valid and created by an authorized developer.

If you still want to verify the signature manually, enter the following at the command line:

java -jar /path/to/i2p.jar su3file verifysig -k /path/to/certificates/plugin/signer_at_mail.i2p.crt /path/to/plugin.su3

Note: most plugins' source codes are downloadable from the I2P's Monotone server[19].

Tails

Installation of plugins is disabled in Tails.[20]

Plugin Development

Those looking to create new plugins for I2P might want to look at the introduction to plugin development, the plugin specification, and the development forum (zzz.i2p).

References

  1. I2Phex v3.2.7 standalone available from http://echelon.i2p/i2phex/
  2. http://zzz.i2p/topics/2162-jircii-2014-12-9-z1
  3. ed2k://|file|jIRCii.xpi2p|319207|E08E77D0B9A76455C6EA55C0C1E3A477|h=V5S4ZMFRPWNLHEMY7EDIWDEYU33EGUU6|/
  4. "Julya is a network enabled Jython shell, allowing multiple instances of Jython to be managed from a network connection. Jython scripts can be run in a headless environment by sending scripts via TCP connections defined by the user."
  5. "Outertubes ia an HTTP Outproxy. It allows other I2P users to connect to the regular Internet via your machine." from http://archiv.tutorials.i2p/i2p-plugins/outertubes/
  6. http://zzz.i2p/topics/1149
  7. 0.19.0-b1 released in 2015
  8. After installation, a brief help page will be available at http://127.0.0.1:7662/help.html. Be sure to read it completely!
  9. http://zzz.i2p/search?type=topics&query=zzzot&commit=Search
  10. 0.4-b1 released in 2025
  11. See readme for prometheus server configuration.
  12. http://forum.i2p/viewtopic.php?t=7468&highlight=yuDownloader
  13. http://direct.i2p/site/webcache/8846695?rId=56eeff4c9298c&seq=1
  14. jamwiki.org/wiki/en/FAQ
  15. https://subgraph.com/orchid/
  16. http://direct.i2p/site/webcache/9450470?rId=56ef019684452&seq=2
  17. http://zzz.i2p/topics/2267-lost-plugin-directory
  18. http://zzz.i2p/topics/2853-rip-bote
  19. http://i2p-projekt.i2p/en/get-involved/guides/monotone
  20. http://forum.i2p/viewtopic.php?t=12482

External links