source: debian-alt/doc/dependencies.txt @ 51a6f29

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

Debian: Remove libecj-java dependency (ticket #2094)
Add taglibs-standard-* to apparmor list (ticket #2093)

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