AusweisApp2(1)

1AusweisApp2(1)              General Commands Manual             AusweisApp2(1)
2
3
4

NAME

6       AusweisApp2 - Official authentication app for German ID cards and resi‐
7       dence permits
8

SYNOPSIS

10       AusweisApp2 [-h|--help]
11       AusweisApp2 [--help-all]
12       AusweisApp2 [-v|--version]
13       AusweisApp2 [--show]
14       AusweisApp2 [--keep] [--no-logfile] [--no-loghandler]  [--show]  [--no-
15       proxy] [--ui { qml|websocket }] [--port PORT] [--address ADDRESS]
16
17

DESCRIPTION

19       AusweisApp2  allows  you  to authenticate yourself against websites via
20       your German ID card and residence permits.
21
22       You will need:
23       * an ID card that is enabled for online identification
24       * A compatible NFC device (most NFC readers  should  work,  NFC-enabled
25       phones can * also be used)
26       * AusweisApp2
27       * A browser
28       * A website that supports authentication via German ID card
29
30       When  you  visit such a website, AusweisApp2 will be triggered and will
31       ask you if you want to authenticate against the website.
32
33       This program will provide a local webserver for your browser to  inter‐
34       face against.
35
36

OPTIONS

38       -h, --help
39              Displays a short help message.
40
41
42       --help-all
43              Displays help including Qt specific options.
44
45
46       -v, --version
47              Displays version information.
48
49
50       --keep
51              By  default,  AusweisApp2  writes  a  log  to  a  file  matching
52              ${TMP}/AusweisApp2.*.log. When the program terminates,  it  will
53              be deleted. This setting prevents deletion.
54
55
56       --no-logfile
57              Suppress  writing  a  log file to ${TMP}/AusweisApp2.*.log. Logs
58              will still be written to STDOUT.
59
60
61       --no-loghandler
62              Disable default log handler. This disables logging to STDOUT.
63
64
65       --show Show window on startup.
66
67
68       --no-proxy
69              Disable system proxy.
70
71
72       --ui { qml|webservice|websocket }
73              This option allows multiple values.  - "qml" will start the pro‐
74              gram  with a visible UI.  - "websocket" will let it start in the
75              background as an SDK.  This  is  only  useful  when  integrating
76              AusweisApp2  into other programs.  - "webservice" starts listen‐
77              ing on given port/address.
78
79              Default is "qml,webservice,websocket".
80
81
82       --port PORT
83              Change the listening port for the WebSocket. Default  is  24727.
84              Selecting  "0" is a special case. AusweisApp2 will then select a
85              random  port  and  write  the  port  number   to   a   file   in
86              ${TMP}/AusweisApp2.<PID>.port.
87
88
89       --address ADDRESS
90              Use  given addresses for interface binding. Normally AusweisApp2
91              is bound to localhost only as it is a security requirement. Use‐
92              ful for testing only.  This option allows multiple values.
93
94

RETURN VALUE

96       AusweisApp2 will return 0 when successfully terminated.
97

ENVIRONMENT

99       QT_QPA_PLATFORM={ wayland|X11 }
100              You  may  force the session type to wayland or X11. This is only
101              needed for debugging purposes. XDG_SESSION_TYPE will be  ignored
102              on gnome.
103
104

FILES

106       ~/.config/AusweisApp2_CE/AusweisApp2.conf File path where the user con‐
107       fig is saved.
108
109

CAVEATS

111       Currently there is no way to terminate the  program  on  gnome  as  the
112       TrayIcon is mandatory.
113
114

AUTHOR

116       This man page was written by Lee Garrett (debian@rocketjump.eu) for De‐
117       bian (but may be used by others).
118
119