git.maemo.org Git - keepassx/blob - src/res/docs/quickstart.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html>
   4 <head>
   5         <title>KeePassX Quick-start Guide</title>
   6 </head>
   7 <body>
   8         <a name="top" />
   9         <h1>KeePassX Quick-start Guide</h1>
  10         <p>
  11                 This guide helps you to manage your
  12                 passwords efficiently and securely with KeePassX.
  13         </p>
  14
  15         <a name="startup" />
  16         <h2>Starting up</h2>
  17         <p>
  18                 After starting KeePassX for the first time, you
  19                 are presented with the main window with
  20                 no open database file. If you have used KeePassX
  21                 (or KeePass Classic on Windows) previously, you can
  22                 open your existing database. Otherwise we begin
  23                 with creating a new password database.
  24         </p>
  25
  26         <a name="database_create" />
  27         <h2>Creating a new password database</h2>
  28         <p>
  29                 KeePassX stores your password entries into
  30                 a password database file when the it's not running.
  31                 To create a new password database, click the
  32                 <span class="gui">&quot;New Database&quot;</span>
  33                 icon on the program toolbar (it is the first icon from the
  34                 left on the toolbar).
  35         </p>
  36         <p>
  37                 Second, you need to set the <b>master key</b> for the
  38                 password database. This key is used to encrypt (ie. lock)
  39                 the password database so it cannot be read by anybody
  40                 else but you. The master key can be a password
  41                 or a key file or both.
  42                 If you check both, you must provide both the password
  43                 and the key file to every time you want to unlock the database.
  44         </p>
  45         <p>
  46                 If you decide to use a password,
  47                 <a href="http://www.us-cert.gov/cas/tips/ST04-002.html">
  48                 choose and protect it carefully</a> <img src="external.png" />.
  49                 The password should be strong, ie. long enough
  50                 (at least 8 characters) and preferably contain lower and
  51                 uppercase characters, numbers and special characters (e.g. !#?).
  52                 You should also  memorize the password well, because
  53                 if you forget it, there is no way retrieving it later
  54                 from the locked database. You will be asked
  55                 to give the password twice to ensure that
  56                 there is no typing errors in the password.
  57         </p>
  58         <p>
  59                 The key file can be any file on your computer, e.g. a picture or
  60                 a text document.
  61                 You can also create a randomly-generated key file by first
  62                 selecting the key file check box and clicking
  63                 <span class="gui">&quot;Generate Key File...&quot;</span>.
  64                 You can store the key file for example on a USB memory stick,
  65                 to keep it with you everywhere.
  66         </p>
  67
  68         <a name="password_add" />
  69         <h2>Adding password entries</h2>
  70         <p>
  71                 After you have created or opened a database, you
  72                 can add password entries to the database.
  73                 A password entry essentially consists of a title,
  74                 user name and password. It may have other entries
  75                 as well, such as URL (Internet link) and comments.
  76                 To add a new password entry, select a group from
  77                 the list on the left first, then
  78                 click the <span class="gui">
  79                 &quot;Add New Entry&quot;</span> icon on the program toolbar.
  80         </p>
  81         <p>
  82                 In the &quot;New Entry&quot; dialog you can enter
  83                 the information you want to into respective text boxes.
  84                 If you are creating a new account to e.g. a web forum,
  85                 you can use the password generator to generate strong
  86                 random passwords for you.
  87         </p>
  88
  89         <a name="database_save" />
  90         <h2>Saving the database</h2>
  91         <p>
  92                 If you have added or edited entries in your database,
  93                 they are not automatically save to the database file by default.
  94                 You can save the database by clicking the <span class="gui">
  95                 &quot;Save Database&quot;</span> icon.
  96         </p>
  97         <p>
  98                 You may also want to
  99                 enable <span class="gui">&quot;Automatically save database
 100                 after every change&quot;</span> option from the
 101                 <span class="gui">&quot;Extras&quot;</span> &gt;
 102                 <span class="gui">&quot;Settings...&quot;</span> &gt;
 103                 <span class="gui">&quot;General (2)&quot;</span> page.
 104                 (On OS X, the page is found from
 105                 <span class="gui">&quot;KeePassX&quot;</span> (Application menu) &gt;
 106                 <span class="gui">&quot;Preferences&quot;</span>.)
 107         </p>
 108
 109         <a name="database_open" />
 110         <h2>Opening a database</h2>
 111         <p>
 112                 By default, on next startup, KeePassX opens a
 113                 <span class="gui">&quot;Enter Master Key&quot;</span>
 114                 dialog for the last used password database. If you wish
 115                 to open another password database, click
 116                 <span class="gui">&quot;Cancel&quot;</span>
 117                 and click <span class="gui">&quot;Open Database&quot;</span> icon
 118                 on the program toolbar and select the wanted password
 119                 database file from the file system. You can, of course,
 120                 do this at any point when the KeePassX main window is active.
 121         </p>
 122
 123         <a name="password_edit" />
 124         <h2>Editing and removing password entries</h2>
 125         <p>
 126                 If you wish to edit a password entry, you can do
 127                 so by double-clicking on the entry title,
 128                 or by selecting the entry and then clicking the
 129                 <span class="gui">&quot;View/Edit Entry&quot;</span> icon
 130                 on the program toolbar.
 131         </p>
 132         <p>
 133                 To delete a password entry, first select the
 134                 entry and click <span class="gui">&quot;Delete Entry&quot;</span> icon
 135                 on the program toolbar or hit <tt>Ctrl-D</tt> (<tt>Cmd+D</tt> on OS X)
 136                 on the keyboard.
 137         </p>
 138
 139         <a name="password_copy" />
 140         <h2>Copying password (and user name) to the clipboard</h2>
 141         <p>
 142                 You can copy the currently selected password by hitting <tt>Ctrl-C</tt>
 143                 (<tt>Cmd-C</tt> on OS X) and user name with <tt>Ctrl-B</tt> (<tt>Cmd-B</tt>
 144                 on OS X) on the keyboard. Then you can hit <tt>Ctrl-V</tt>
 145                 (<tt>Cmd-V</tt> on OS X) to paste the password or username
 146                 to any program that supports pasting from the clipboard.
 147         </p>
 148
 149         <a name="autotype" />
 150         <h2>Setup Auto-Type (currently Linux only)</h2>
 151         <p>
 152                 <b>Auto-Type</b> is a feature that allows you to e.g. log in
 153                 to web page by hitting only one key combination.
 154                 KeePassX does the rest of the typing for you. Auto-Type reads
 155                 the title of currently active window on your screen
 156                 and matches it to the configured database entries.
 157                 If a matching window title is found from the password
 158                 database, it executes a predefined key sequence
 159                 (by default your username, <tt>TAB</tt>, password, <tt>ENTER</tt>) in
 160                 the active window. This feature is currently available
 161                 in the Linux version only.
 162         </p>
 163         <p>
 164                 To enable Auto-Type, first go to
 165                 <span class="gui">&quot;Extras&quot;</span> &gt;
 166                 <span class="gui">&quot;Settings...&quot;</span> &gt;
 167                 <span class="gui">&quot;Advanced&quot;</span> page
 168                 and set the <span class="gui">&quot;Global Auto-Type Shortcut&quot;</span>
 169                 by clicking the text box and typing the desired
 170                 keyboard shortcut (e.g. <tt>Ctrl-Shift-N</tt>).
 171                 Click <span class="gui">&quot;OK&quot;</span> to exit the dialog.
 172         </p>
 173         <p>
 174                 Then, for example, open the web page where you
 175                 want to be able to log in with Auto-Type. Let's
 176                 for example open Google.com into Firefox and
 177                 try to do automated search with Auto-Type. Go
 178                 to Google.com in Firefox and you'll notice
 179                 that your window title is now &quot;Google - Mozilla Firefox&quot;
 180         </p>
 181         <p>
 182                 Now, create new password entry, that
 183                 contains user name &quot;test&quot;.
 184                 Then, click the small <span class="gui">&quot;Tools&quot;</span>
 185                 button at the bottom of the <span class="gui">&quot;New Entry&quot;</span>
 186                 dialog, and select <span class="gui">&quot;Auto-Type: Select target window&quot;</span>
 187                 Select &quot;Google - Mozilla Firefox&quot; from the dropdown menu and
 188                 click <span class="gui">&quot;OK&quot;</span>. You should see now a new
 189                 line in the <span class="gui">&quot;Comment:&quot;</span> box, which reads:<br/><br/>
 190
 191                 <tt>Auto-Type-Window: Google - Mozilla Firefox</tt><br/><br/>
 192
 193                 Now you have associated that window title to this entry.
 194         </p>
 195         <p>
 196                 Finally, let's customize the Auto-Type key sequence
 197                 to just enter your username and hit <tt>ENTER</tt>.
 198                 Click again <span class="gui">&quot;Tools&quot;</span>
 199                 and select <span class="gui">&quot;Auto-Type: Customize Sequence&quot;</span>.
 200                 Now there's another new line in the <span class="gui">&quot;Comment:&quot;</span> box,
 201                 which reads:<br/><br/>
 202
 203                 <tt>Auto-Type: {USERNAME}{TAB}{PASSWORD}{ENTER}</tt><br/><br/>
 204
 205                 Change this line to:<br/><br/>
 206
 207                 <tt>Auto-Type: {USERNAME}{ENTER}</tt><br/><br/>
 208
 209                 So that it would just type in your username and hit <tt>ENTER</tt>.
 210                 Click <span class="gui">&quot;OK&quot;</span> to save the entry.
 211         </p>
 212         <p>
 213                 Now, you can test the Auto-Type by returning to the
 214                 Firefox window and hitting the global Auto-Type keyboard
 215                 shortcut (e.g. <tt>Ctrl-Shift-N</tt>) in it.
 216                 If everything went correctly, KeePassX should now enter
 217                 &quot;test&quot; in the search box and start the search query
 218                 by hitting <tt>ENTER</tt>.
 219         </p>
 220         <p>
 221                 By modifing the Auto-Type key sequence you can tailor
 222                 Auto-Type to suit almost every web login page you'll enter.
 223         </p>
 224
 225 <!--
 226         <a name="" />
 227         <h2></h2>
 228         <p>
 229
 230         </p>
 231 -->
 232 </body>
 233 </html>