1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="expires" content="0" />
<meta http-equiv="cache-control" content="no-cache" />
<meta http-equiv="pragma" content="no-cache" />
<meta name="author" content="Dominik Reichl" />
<meta name="DC.title" content="Setup - KeePass" />
<meta name="DC.creator" content="Dominik Reichl" />
<meta name="DC.type" content="Text" />
<meta name="DC.format" content="text/html" />
<meta name="DC.language" content="en" />
<meta name="DC.rights" content="Copyright (C) 2003-2019 Dominik Reichl" />
<meta name="robots" content="index, follow" />
<meta name="flattr:id" content="42rykv" />
<title>Setup - KeePass</title>
<base target="_self" />
<link rel="stylesheet" type="text/css" href="../../default.css" />
</head>
<body>
<table class="sectionsummary"><tr><td width="68">
<img src="../images/b64x64_package_system.png" width="64" height="64"
class="singleimg" align="left" alt="System" />
</td><td valign="middle"><h1>Installation / Portability</h1><br />
KeePass 2.x installation, uninstallation, portability and updates.
</td></tr></table>
<ul>
<li><a href="#info">General information</a></li>
<li><a href="#installer">Installer program (KeePass-2.xx-Setup.exe file)</a></li>
<li><a href="#portable">Portable version (KeePass-2.xx.zip file)</a></li>
<!-- <li>Other operating systems than Windows:
<ul> -->
<li><a href="#mono">Running KeePass under Mono (Linux, Mac OS X, BSD, ...)</a></li>
<li><a href="#wine">Running KeePass under Wine (Linux, Mac OS X, BSD, ...)</a></li>
<!-- <li><a href="#monoportable">Portable KeePass using Mono</a></li> -->
<!-- </ul>
</li> -->
<li><a href="#mig1x">Migrating from KeePass 1.x to 2.x</a></li>
</ul>
<br />
<a name="info"></a>
<h2 class="sectiontitle">
<img src="../images/b16x16_tar.png" class="singleimg" alt="Setup" /> General
information</h2>
<p>When downloading KeePass, you have the choice between 3 different packages:</p>
<ul>
<li><b>KeePass-<i>2.xx</i>-Setup.exe:</b> An installer program for Windows.</li>
<li><b>KeePass-<i>2.xx</i>.zip:</b> A KeePass ZIP package (portable version).</li>
<li><b>KeePass-<i>2.xx</i>-Source.zip:</b> The source code.</li>
</ul>
<p>The installer and the portable version are described in detail below.</p>
<p>The source code package contains everything you need to compile KeePass.
It includes the C#/C++ source code and header files, resource files,
sources for building the installer, etc.</p>
<!-- <p>Both installed and portable KeePass versions require a .NET framework,
see the downloads page for details.</p> -->
<p><b>Updating KeePass:</b><br />
When a new KeePass version has been released, you can update your existing KeePass
installation, without losing any configuration settings. The steps are
depending on which package you are using (installer or portable), see below.</p>
<p>Translations should also be updated when you install a new KeePass version.
You can find the latest translation files here:
<a href="https://keepass.info/translations.html" target="_blank">KeePass Translations</a>.</p>
<br />
<a name="installer"></a>
<h2 class="sectiontitle">
<img src="../images/b16x16_package_system.png" class="singleimg" alt="Setup" /> Installer
program (KeePass-2.xx-Setup.exe file)</h2>
<p>The KeePass development team provides an installer, which copies KeePass
to your hard disk, creates shortcuts in the start menu and associates
KDBX files with KeePass, if desired.</p>
<p>Additionally, KeePass is automatically configured to store its settings in
the application data directory of the current user.
This way multiple users can use one KeePass
installation without overwriting each other's settings (each user has his
own <a href="../base/configuration.html">configuration</a> file).
The setup program must run with administrative
rights, however KeePass runs fine without administrative rights once it
is installed.</p>
<p><b>Installation:</b><br />
To install KeePass, run the <code>KeePass-2.xx-Setup.exe</code> file
and follow the wizard.</p>
<p><b>Updating:</b><br />
Run the <code>KeePass-2.xx-Setup.exe</code> file.
You do <i>not</i> need to uninstall the old version first.
Your configuration options will not be lost.</p>
<p><b>Uninstallation:</b><br />
In order to uninstall KeePass, run the uninstallation program, which is
accessible by a shortcut in the start menu folder of KeePass, or in
the program section of the system control panel. If you also want
to remove your configuration settings, you need to delete the configuration
file in the application data directory of your user profile, see
<a href="../base/configuration.html">Configuration</a>.</p>
<p><b>Silent Installation:</b><br />
The KeePass installer <code>KeePass-2.xx-Setup.exe</code> supports command line
switches for silent installation, i.e. the program gets installed without
asking the user for target directory or association options. The default settings
of the installer are used.</p>
<p>The <code>/SILENT</code> command line switch performs a silent
installation and shows a status dialog during the setup process. No questions
will be asked though.</p>
<p>The <code>/VERYSILENT</code> command line switch performs a silent
installation and does <i>not</i> show a status dialog during the setup process.</p>
<p><b>Destination Path:</b><br />
The installer allows to choose the destination path to which KeePass is
installed.
However, when the installer detects an existing KeePass installation, it
assumes that the user wants to perform an upgrade and thus doesn't
display the destination path selection page; the old version will be overwritten
by the new version.
If you want to move an existing KeePass installation to a different path,
first uninstall the old version; the installer of the new version will then
display the destination path selection page again.</p>
<p><b>Options/Components:</b><br />
The installation options/components are explained in detail here:
<a href="https://keepass.info/help/kb/faq.html#instopt2x" target="_blank">What
do the 2.x installation options/components mean in detail?</a>.</p>
<br />
<a name="portable"></a>
<h2 class="sectiontitle">
<img src="../images/b16x16_usbpendrive_unmount.png" class="singleimg" alt="Setup" /> Portable
version (KeePass-2.xx.zip file)</h2>
<p>The portable version can be carried around on portable devices (like USB
sticks) and runs on any computer directly from the device, without any
installation<!-- (provided that a .NET framework is installed) -->.
It doesn't store anything on your system (in contrast to
the setup package, see above). KeePass doesn't create any new
registry keys and it doesn't create any configuration files in your Windows
or application data directory of your user profile.</p>
<p>Make sure that KeePass has write access to
its application directory. Otherwise, if it doesn't have, it'll attempt
to store the configuration options (nothing security-relevant though) into the
application data directory of the currently logged on user.
For more about that, see this page:
<a href="../base/configuration.html">Configuration</a>.</p>
<p><b>Installation:</b><br />
KeePass does not need to be installed. Just download the ZIP package, unpack
it with your favorite ZIP program and KeePass is ready to be used. Copy it to
a location of your choice (for example onto your USB stick); no
additional configuration or installation is needed.</p>
<p><b>Updating:</b><br />
Download the latest portable package of KeePass, unpack it
and copy all new files over the old ones. Your configuration settings will not
be lost (the settings are stored in the <i>KeePass.config.xml</i> file,
which won't be overwritten, because KeePass ZIP packages don't
include a <i>KeePass.config.xml</i> file).</p>
<p><b>Uninstallation:</b><br />
Simply delete the KeePass folder. This will leave no trace of KeePass on
your system.</p>
<br />
<a name="mono"></a>
<h2 class="sectiontitle">
<img src="../images/b16x16_package_system.png" class="singleimg" alt="Setup" /> Running
KeePass under Mono (Linux, Mac OS X, BSD, ...)</h2>
<p>In addition to Windows, KeePass 2.x runs under Mono,
i.e. Linux, Mac OS X, BSD, etc.</p>
<p>Links to all supported packages can be found on the
<a href="https://keepass.info/download.html" target="_blank">Downloads</a> page.</p>
<ul>
<li><strong>Debian/Ubuntu Linux:</strong><br />
Install the <em>keepass2</em> /
<em>KeePass 2.x for Debian/Ubuntu Linux</em> package (e.g. using APT).
A link to a page with more information about this package can be found on the
downloads page.<br />
<br /></li>
<li><strong>Fedora Linux:</strong><br />
Install the <em>keepass</em> package
(from the Fedora repository; link on the downloads page).<br />
<br /></li>
<li><strong>OpenSUSE Linux:</strong><br />
Install the <em>keepass</em> package
(from the OpenSUSE Mono repository; link on the downloads page).<br />
<br /></li>
<li><strong>Gentoo Linux:</strong><br />
Install the <em>keepass</em> package
(from the Gentoo Linux repository; link on the downloads page).<br />
<br /></li>
<li><strong>Arch Linux:</strong><br />
Install the <em>keepass</em> package
(from the Arch Linux repository; link on the downloads page).<br />
<br /></li>
<li><strong>Mac OS X:</strong><br />
Install the <em>KeePass 2.x for Mac OS X</em> package
(link on the downloads page).<br />
<br /></li>
<li><strong>FreeBSD:</strong><br />
Install the <em>keepass</em> package
(from the FreeBSD ports tree or binary pkg repository; link on the downloads page).<br />
<br /></li>
<li><strong>Other Unix-like systems:</strong><br />
In order to run KeePass, follow these steps:
<ol>
<li>Install <a href="https://www.mono-project.com/"
target="_blank">Mono ≥ 2.6</a> (older versions will not work and are
not supported). Depending on your platform, the packages to install are called
<code>mono-stable</code>, <code>MonoFramework</code>,
<code>mono-devel</code> or <code>mono-2.0-devel</code>; see
the <a href="https://www.mono-project.com/" target="_blank">Mono project page</a>,
if you are unsure which packages to install.</li>
<li>On some platforms, the Windows Forms implementation (System.Windows.Forms)
is offered as a separate package. KeePass requires this package; so if you see one, install it, too.</li>
<li>On some platforms, the Runtime namespace (System.Runtime)
is offered as a separate package. KeePass requires this package; so if you see one, install it, too.</li>
<li>If you want to use auto-type on Linux / Mac OS X / BSD / etc., you additionally
need the <code>xdotool</code> package.</li>
<li>Download the portable version of KeePass (ZIP package)
and unpack it to a location of your choice.</li>
<li>When being in the KeePass directory, run the command line
"<code>mono KeePass.exe</code>". Alternatively, right-click onto
the <code>KeePass.exe</code> file, choose "Open with Other Application"
and type in <code>mono</code> as custom command.</li>
</ol>
<p>For the last step you might want to create a shortcut
or shell script file with this command line (use an absolute path to
<code>KeePass.exe</code>, if the shortcut / shell script file is in a
different location).</p>
<p><b>Clipboard:</b><br />
On some systems, Mono's clipboard routines don't work properly.
In this case, install the <code>xsel</code> and <code>xdotool</code> packages.
If these are installed, KeePass uses them for clipboard operations.</p>
<p><b>Global Auto-Type:</b><br />
In order to use <a href="../base/autotype.html#autoglobal">global auto-type</a>,
you need to create an appropriate system-wide hot key. This only needs to be done
manually once. KeePass performs global auto-type when it's invoked with
the <code>--auto-type</code> <a href="../base/cmdline.html">command line</a> option.</p>
<p>Some examples how to create a system-wide hot key for global auto-type,
for different operating systems:</p>
<ul>
<li><b>KDE.</b>
On Linux systems with KDE, the hot key can be created in <i>Computer</i>
→ <i>System Settings</i> → <i>Shortcuts and Gestures</i>:
in this dialog, go <i>Edit</i> → <i>New</i> → <i>Global Shortcut</i> →
<i>Command/URL</i>, specify the shortcut on the <i>Trigger</i> tab
and enter<br />
<code>mono /<i>YourPathToKeePass</i>/KeePass.exe --auto-type</code><br />
into the <i>Command/URL</i> field on the <i>Action</i> tab.
</li>
<li><b>Ubuntu Linux ≥ 11.04 (Unity/GNOME).</b>
Open the dialog <i>Keyboard Shortcuts</i> in the system preferences,
click the <i>Add</i> button, enter <code>KeePass Auto-Type</code> as name
and<br />
<code>mono /<i>YourPathToKeePass</i>/KeePass.exe --auto-type</code><br />
as command, then click [Apply]. Click on <i>Disabled</i> of the newly
created item (such that the text <i>'New shortcut...'</i> appears),
press <kbd><kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>A</kbd></kbd>, and close the dialog.
</li>
<li><b>Ubuntu Linux ≤ 10.10 (GNOME).</b>
<ol>
<li>Press Alt-F2, enter <code>gconf-editor</code> and click [OK].</li>
<li>Navigate to <code>apps</code> → <code>metacity</code> → <code>keybinding_commands</code>.</li>
<li>Double-click one of the <code>command_<i>i</i></code> items, enter<br />
<code>mono /<i>YourPathToKeePass</i>/KeePass.exe --auto-type</code><br />
and click [OK].</li>
<li>Click the <code>global_keybindings</code> node on the left.</li>
<li>Double-click the appropriate <code>run_command_<i>i</i></code> item
(for example, when you've used <code>command_5</code> in the previous steps,
double-click <code>run_command_5</code> now) and specify the hot key of your
choice. For example, to use <kbd><kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>A</kbd></kbd>
as hot key, you'd enter <code><Control><Alt>a</code>.</li>
</ol>
</li>
</ul>
<p>Important: for global auto-type, the version of the <code>xdotool</code> package
must be 2.20100818.3004 or higher! If your distribution only offers an
older version, you can download and install the latest version of the
package manually, see the <a href="https://www.semicomplete.com/projects/xdotool/"
target="_blank"><code>xdotool</code></a> website.</p>
<p><strong>Plugins:</strong><br />
On some Linux systems, the <code>mono-complete</code> package may be
required for plugins to work properly.</p>
<p><strong>TLS 1.2:</strong><br />
For TLS 1.2 support, Mono 4.8.0 or higher (or .NET Framework 4.5 or higher)
is required.</p>
</li>
</ul>
<br />
<a name="wine"></a>
<h2 class="sectiontitle">
<img src="../images/b16x16_package_system.png" class="singleimg" alt="Setup" /> Running
KeePass under Wine (Linux, Mac OS X, BSD, ...)</h2>
<p>Although you can run KeePass 2.x more or less natively on Unix-like systems
using Mono (see above), the user interface doesn't always look pretty.
Some users therefore
prefer running KeePass 2.x under Wine, which works fine, too.</p>
<p>In order to run KeePass 2.x under Wine, follow these steps:</p>
<ol>
<li>Make sure that Wine is installed.
Typically the package to install is called <code>wine</code>.</li>
<li>Make sure that .NET Framework 4.5 or higher is installed in Wine, see
<a href="https://appdb.winehq.org/objectManager.php?sClass=application&iId=2586"
target="_blank">WineHQ AppDB: .NET Framework</a>.<br />
For installing .NET Framework 4.5, <code>winetricks</code> can be used, see
<a href="https://appdb.winehq.org/objectManager.php?sClass=version&iId=25478"
target="_blank">WineHQ AppDB: .NET Framework 4.5</a>.</li>
<li>Download the latest portable package of KeePass 2.x (ZIP file) and unpack it
into some directory of your choice.</li>
<li>Run <code>wine KeePass.exe</code>.</li>
</ol>
<p><strong>Theme.</strong>
By default, Wine uses the classic Windows theme. If you prefer some other
theme, you can install it in 'Applications' → 'Wine' → 'Configure Wine' →
tab 'Desktop Integration'.
Links to themes can for instance be found on
<a href="https://en.wikipedia.org/wiki/Windows_XP_visual_styles"
target="_blank">Wikipedia: Windows XP visual styles</a>.</p>
<!-- <p><strong>Mac OS X.</strong>
In order to make a Mac application bundle wrapper, you can use
<a href="http://wineskin.urgesoftware.com/" target="_blank">Wineskin</a>.
In the wrapper settings, we recommend to go to 'Screen Options' and turn on
the option 'Use Mac Driver instead of X11'.</p> -->
<!-- <br />
<a name="monoportable"></a>
<h2 class="sectiontitle">
<img src="../images/b16x16_usbpendrive_unmount.png" class="singleimg" alt="Setup" /> Portable
KeePass using Mono</h2>
<p><i>The approach below worked perfectly when this documentation was written.
However, as this type of Mono installation is nowhere mentioned on the Mono
website, it might stop working with a future Mono release.</i></p>
<p>Although almost all of today's PCs can run .NET applications (the .NET Framework
is already preinstalled on Windows ≥ Vista, and for all major Linux / Mac OS X
distributions Mono is available, which actually even is a dependency of the GNOME
≥ 2.16 desktop), you still might want to run KeePass 2.x on a PC without
any .NET support, like an old Windows XP system where you don't have administrative
rights to install the .NET Framework.</p>
<p>For such a situation, you can create a portable version of KeePass using Mono,
which works on PCs without .NET. To do this, follow these steps (assuming a Windows PC):</p>
<ol>
<li>Download the latest portable ZIP package of KeePass 2.x
(file <code>KeePass-<i>2.xx</i>.zip</code>).
Unpack it to some location, e.g. a folder <code>E:\KeePass</code> on your USB stick.</li>
<li>Download the latest Mono installer. Run it to locally install Mono on your current
PC (e.g. on <code>C:</code>).
KeePass doesn't require GTK+, GNOME or XSP, so you can disable the options for these during
the installation.</li>
<li>After installing Mono, copy
the whole Mono application folder
(e.g. <code>C:\Program Files\Mono</code>)
to your USB stick, e.g. to <code>E:\Mono</code>.</li>
<li>In order to simplify starting KeePass, create a batch file on your USB stick,
e.g. <code>E:\RunKeePass.bat</code>. This batch file should run KeePass using
the <code>mono.exe</code> application on the USB stick. For example, with the paths above,
the content of the batch file would look like:
<pre>
START "" Mono\bin\mono.exe KeePass\KeePass.exe
</pre>
</li>
</ol>
<p>In order to run KeePass on a PC without .NET support, simply plug in
the USB stick and run the batch file.</p>
<p>The approach above should be seen as the very last
possibility to run KeePass 2.x. Installing .NET support (either the .NET
Framework or Mono) is highly recommended instead!</p>
-->
<br />
<a name="mig1x"></a>
<h2 class="sectiontitle">
<img src="../images/b16x16_package_system.png" class="singleimg" alt="Setup" /> Migrating
from KeePass 1.x to 2.x</h2>
<p>In order to migrate from KeePass 1.x to 2.x, follow these steps:</p>
<ol>
<li>Install KeePass 2.x.<br />
If you're using the installer, make sure that the component
'Native Support Library' is being installed
(by default this component is enabled).</li>
<li>Run KeePass 2.x and create a new KDBX database file (via 'File' →
'New').</li>
<li>Import your old KDB database file into your new KDBX database file
(via 'File' → 'Import', file format 'KeePass KDB (1.x)').</li>
</ol>
<p>If everything works fine, you can delete your old KeePass 1.x
installation. The old KDB database file also isn't required anymore,
but you may want to keep it as a backup.</p>
</body></html>
|
