Project

General

Profile

User Guide » History » Version 10

Detlef Hühnlein, 06/05/2013 05:31 PM

1 2 Tobias Wich
h1. About the Open eCard App
2
3
h2. Features
4
5
h2. Changelog
6
7
8
h1. Setup
9
10
h2. Richclient
11
12 5 Tobias Wich
The Richclient is a Java SE application intended to run as a desktop application. It is usually installed on a machine in an operating system specific manner and executed by the user on his own behalf.
13
14
h3. Prerequisites
15
16
* Java SE 6 or higher
17
  Windows and Mac users can get it at https://www.java.com. 
18 7 Tobias Wich
  Debian Squeeze users should install the package @openjdk-6-jre@ and @icedtea6-plugin@, while Wheezy users should install @openjdk-7-jre@ and @icedtea-7-plugin@.
19 5 Tobias Wich
20
h3. Installation
21
22
# Direct your Browser to https://www.openecard.org/download/pc
23
# Click the Open eCard App launch Button
24
25 2 Tobias Wich
h2. Android
26
27
28
h1. Operation
29
30
h2. General
31
32
h2. App Activation
33
34 3 Tobias Wich
h1. Configuration
35 2 Tobias Wich
36 3 Tobias Wich
Each client implementation of the Open eCard App uses a common base set of configuration options and possibly additional client specific settings. The clients provide their own configuration dialogs that are appropriate for the platform or operating system they are running on.
37 1 Detlef Hühnlein
38 3 Tobias Wich
In the rest of this section the settings common to all client implementations are defined and explained. The sections afterwards describe the client specific settings as well as the UIs that provide a more user friendly way to modify these settings.
39 1 Detlef Hühnlein
40 3 Tobias Wich
h2. List of Common Settings
41 1 Detlef Hühnlein
42 8 Tobias Wich
The Open eCard App loads and saves all its settings to a "Java style property":https://en.wikipedia.org/wiki/.properties file. This file is user specific and can be found under the path @$HOME/.openecard/openecard.properties@. Besides this config file, the @.openecard@ directory may contain other client or plugin specific files, like log settings or log files.
43 3 Tobias Wich
44
45
h3. Proxy Settings
46
47 9 Detlef Hühnlein
The Open eCard App supports SOCKS and HTTP(S) proxies, which are configured using the following properties:
48
49 10 Detlef Hühnlein
<pre>
50
SOCKS:
51
proxy.socks.host = localhost -- Hostname or IP address of the server where the SOCKS proxy server is running on.
52
proxy.socks.port = 8080 -- Port on the proxy host where the proxy service is listening on.
53 1 Detlef Hühnlein
54 10 Detlef Hühnlein
HTTP(S):
55
proxy.http.scheme = http -- specifies the protocol scheme of the proxy (http or https)
56
proxy.http.host = localhost -- Hostname or IP address of the server where the proxy server is running on.
57
proxy.http.port = 8123 -- Port on the proxy host where the proxy service is listening on.
58
#proxy.http.user = foo -- user name for basic authentication (optional)
59
#proxy.http.pass = bar -- password for basic authentication (optional)
60
proxy.http.validate_tls = true -- specifies that the certificate of the proxy service is validated against the java key store (optional)
61
</pre>
62 1 Detlef Hühnlein
63 6 Tobias Wich
h2. Richclient Settings
64
65
h1. Troubleshooting
66
67
h2. Logging
68
69
Each client may use a different logging framework. In the applet, Java Util Logging is used to save space of the executable while in the richclient, Logback provides a feature rich logging framework. Both are configured differently.
70
71
The logging configuration can be modified by a config file in the directory $HOME/.openecard (%HOME/.openecard for Microsoft Windows systems). The file must be named applet_log.properties for the applet and richclient_logback.xml for the richclient. Samples can be found at the end of this page.
72
73
After adding the config file, the log granularity of the packages and/ or classes must be configured. The syntax and possibilities of each logging framework are different from each other. The samples include an exemplary line for a package. For further details consult the documentation of the logging framework in use.
74
75
The following is a list of important packages to find errors. A complete list is available in the "JavaDoc":https://dev.openecard.org/projects/open-ecard/apidocs/index.html.
76
* @org.openecard.transport.paos@
77 2 Tobias Wich
* @org.openecard.ifd.scio@
78
* @org.openecard.sal@
79
* @org.openecard.sal.protocol.eac@
80
81 1 Detlef Hühnlein
h2. Error Messages
82
83
h2. Reporting Problems