source: debian-alt/doc/dependencies.txt @ 5ddb4ed

Last change on this file since 5ddb4ed was 5ddb4ed, checked in by zzz <zzz@…>, 3 years ago

fixups after review

  • Property mode set to 100644
File size: 7.7 KB
Line 
1This document is for Debian package maintainers.
2It contains an overview of current package dependencies,
3the plan for improvement, and other notes.
4These notes will also be helpful for non-Debian package maintainers.
5
6We are not packaging experts, but we are doing the best we can to
7improve our official packages and support other packagers.
8Our packages are available at https://deb.i2p2.de/ and
9instructions are at https://geti2p.net/debian
10
11This document is current as of release 0.9.30, 2017-05-03.
12
13
14Build-only Dependencies
15-----------------------
16
17* ant
18  This is the standard java build system.
19
20
21Current Runtime Dependencies
22----------------------------
23
24* Java JDK/JRE
25  We require openjdk-7-java to build, and any Java 7, 8, or 9 runtime to run.
26  Java 9 may still have some issues; see https://trac.i2p2.de/ticket/1870 for status
27
28* libecj-java
29  This is for compilation on-the-fly of webapps, but we don't really support that,
30  not sure why it's in there, to be researched, candidate for removal.
31
32* geoip-database
33  In non-Debian builds we bundle our own geoip data;
34  for Debian builds we use the system data.
35
36* gettext-base
37  For /usr/share/java/libintl.jar.
38  In non-Debian builds we bundle the source code; it's removed in the Debian source package.
39
40* libgetopt-java
41  For /usr/share/java/gnu-getopt.jar.
42  In non-Debian builds we bundle the source code; it's removed in the Debian source package.
43
44* libjetty9-java
45  For /usr/share/java/jetty9-*.jar.
46  In non-Debian builds we bundle the jars; it's removed in the Debian source package.
47
48* libtomcat8-java
49  For /usr/share/java/tomcat8-*.jar.
50  In non-Debian builds we bundle the jars as packaged in the Jetty 9.2 binary release,
51  which are different than the way they are packaged for Debian.
52  They are removed in the Debian source package.
53
54* glassfish-javaee
55  We need jstl.jar and standard.jar version 1.2.
56  This is an ancient and terrible package, but it's the only place we've found version 1.2 jars.
57  standard.jar classes are inside /usr/share/java/glassfish-appserv-jstl.jar
58  jstl.jar classes are inside /usr/share/java/glassfish-javaee.jar but we can't use it
59  because there are too many conflicting, old, unrelated classes in there, so we currently
60  bundle jstl.jar even in Debian builds.
61  We've found some other packages that contain version 1.1 jars:
62  libjakarta-taglibs-standard-java (containing standard.jar only)
63  and libjstl1.1-java (containing jstl.jar only).
64  Jetty 9 does contain JSTL 1.2 ??? but not in packages???
65  It's not clear why there isn't a libjstl1.2-java package.
66  It also isn't clear why we upgraded to 1.2 years ago, but the rest of the world didn't.
67  And it isn't clear why 1.1 won't work for us.
68
69* service-wrapper
70  In non-Debian builds we bundle the jars; it's removed in the Debian source package.
71  For some Debian and Ubuntu releases, these seem to be much older than what we're bundling,
72  which is 3.5.30, but there's no particular version that we need.
73
74* libgmp-dev
75  In non-Debian builds we bundle compiled C code; in the Debian packages we have a small
76  C shim that links to the libgmp .so file.
77  We depend on libgmp-dev for both the build and the runtime, but perhaps only the
78  libgmp10 package is required for runtime? To be researched.
79
80
81Bundled code, NOT current dependencies
82--------------------------------------
83
84These are packages that we at least partially bundle jars or java source for,
85even in Debian builds. For most of these we could remove the code and add
86a dependency if the package were widely available.
87We have not created private packages for any of these, we just bundle
88the binaries or sources.
89
90* geoip-java
91  Java interface to access geoip data.
92  We bundle source from https://github.com/maxmind/geoip-api-java
93  No package or not widely available.
94  There is a Maven geoip-api package at http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.maxmind.geoip%22
95
96* hashcash
97  One Java source file.
98  From http://www.nettgryppa.com/code/
99  No package or not widely available.
100  We don't really use this code anyway, but it would break compilation if we took it out.
101
102* identicon
103  Small number of Java source files, modified.
104  From https://github.com/PauloMigAlmeida/identicon
105  No package or not widely available.
106
107* jrobin
108  This is the Java graphing package.
109  We bundle a large portion of the 1.6.0 source from https://github.com/OpenNMS/jrobin
110  No package or not widely available.
111  There is an old 1.5.9 Maven jrobin package at http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.jrobin%22
112  Jrobin is in Gentoo.
113
114* libhttpclient-java
115  We only use a few classes from this large package.
116  We require 4.4 or higher which is not available in older distributions.
117  This is 2 MB of dependencies, instead we bundle 20 KB of copied source.
118  If we do add this dependency, we use only the code in
119  /usr/share/java/httpclient.jar and /usr/share/java/httpcore.jar.
120
121* UPnP (cybergarage)
122  Large subsystem, large number of Java source files, modified with several fixes.
123  From https://github.com/cybergarage/cybergarage-upnp
124  No package or not widely available.
125  There is a competing UPnP library (libupnp-java) that is packaged, but it would be
126  a huge effort on our part to port our code to use that library instead.
127  Maybe we will do this some day, but it won't be soon.
128
129* zxing
130  This is the QR/barcode library from Google.
131  We bundle a portion of the source from https://github.com/zxing/zxing
132  No package or not widely available.
133  There are Maven zxing packages at http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.google.zxing%22
134
135
136Other Issues and TODO
137---------------------
138
139* Building
140  As of 0.9.28, our Debian repo at https://deb.i2p2.de just contains
141  binaries copied from Launchpad. It's much easier than building them
142  ourselves, but it leaves non-x86 architectures out of date.
143  The directory above (debian-alt) contains various changes for different distros.
144
145* Configuration
146  So that we may easily support dependency changes in various distributions,
147  and test alternatives, we output configuration settings to the override.properties
148  file in the rules script. There are extensive comments in the
149  rules, i2p-router.install, and i2p-router.links files.
150  There's probably a better or more-standard way to do this, but this makes it
151  easier for us, and for non-Debian packagers, if there are any.
152
153* i2p-doc
154  This is just javadocs.
155  Added priority of 'extra' for 0.9.29, before that, everybody was installing it?
156
157* Init/systemd
158  Kytv did the systemd and init script parts, no idea if it's compliant,
159  needs review.
160
161* JCA issues.
162  This has never been a problem for Debian/Ubuntu, but many Gentoo, Redhat, and Fedora
163  distributions are missing or have broken ECDSA support in the Java Cryptography subsystem.
164  The console sidebar will show a warning and the router will log warnings if
165  ECDSA is not working. The router will still work, but the user will not be able
166  to access newer hidden services on the network. For best results, packagers
167  should ensure that the JCA supports ECDSA.
168  For further info, see https://trac.i2p2.de/wiki/Crypto/ECDSA
169
170* Raspberry Pi
171  The performance of OpenJDK 8 on the raspberry pi is terrible, it's almost
172  unusable. The Oracle JDK is several times faster. But there's no package for that.
173  We tell people to use Oracle for ARM on our download page, but there's no
174  solution for package users.
175
176* Splitting packages further
177  Might be nice to further split up the i2p-router package into just the
178  core headless router and the routerconsole/UI part.
179  Or even the susimail/susidns/i2psnark/i2ptunnel webapps also.
180
181* Plugins
182  We don't have a strategy for building, installing, or finding packages for
183  3rd-party plugins using our plugin system. If we do that, then we can
184  have packages for popular plugins such as i2p-bote.
Note: See TracBrowser for help on using the repository browser.