doc: Typo fix for "Creation-Date".
[gnupg.git] / doc / instguide.texi
1 @c instguide.texi - Installation guide for GnuPG
2 @c Copyright (C) 2006 Free Software Foundation, Inc.
3 @c This is part of the GnuPG manual.
4 @c For copying conditions, see the file gnupg.texi.
5
6 @node Installation
7 @chapter A short installation guide.
8
9 Unfortunately the installation guide has not been finished in time.
10 Instead of delaying the release of GnuPG 2.0 even further, I decided to
11 release without that guide.  The chapter on gpg-agent and gpgsm do
12 include brief information on how to set up the whole thing.  Please
13 watch the GnuPG website for updates of the documentation.  In the
14 meantime you may search the GnuPG mailing list archives or ask on the
15 gnupg-users mailing listsfor advise on how to solve problems or how to
16 get that whole thing up and running. 
17
18 ** Building the software
19
20 Building the software is decribed in the file @file{INSTALL}.  Given
21 that you are already reading this documentation we can only give some
22 extra hints
23
24 To comply with the rules on GNU systems you should have build time
25 configured @command{dirmngr} using:
26
27 @example
28 ./configure --sysconfdir=/etc --localstatedir=/var
29 @end example
30
31 This is to make sure that system wide configuration files are searched
32 in the directory @file{/etc/gnupg} and variable data below @file{/var};
33 the default would be to also install them below @file{/usr/local} where
34 the binaries get installed.  If you selected to use the
35 @option{--prefix=/} you obviously don't need those option as they are
36 the default then.
37
38
39
40 ** Explain how to setup a root CA key as trusted
41
42
43 Such questions may also help to write a proper installation guide.
44
45 [to be written]
46
47
48 XXX Tell how to setup the system, install certificates, how dirmngr relates
49 to GnuPG etc.
50
51 ** Explain how to setup a root CA key as trusted
52
53 X.509 is based on a hierarchical key infrastructure.  At the root of the
54 tree a trusted anchor (root certificate) is required.  There are usually
55 no other means of verifying whether this root certificate is trustworthy
56 than looking it up in a list. GnuPG uses a file (@file{trustlist.txt})
57 to keep track of all root certificates it knows about.  There are 3 ways
58 to get certificates into this list:
59
60 @itemize
61 @item
62 Use the list which comes with GnuPG. However this list only
63 contains a few root certificates.  Most installations will need more.
64
65 @item
66 Let @command{gpgsm} ask you whether you want to insert a new root
67 certificate.  To enable this feature you need to set the option
68 @option{allow-mark-trusted} into @file{gpg-agent.conf}.  In general it
69 is not a good idea to do it this way.  Checking whether a root
70 certificate is really trustworthy requires decisions, which casual
71 users are not up to.  Thus, by default this option is not enabled.
72
73 @item 
74 Manually maintain the list of trusted root certificates. For a multi
75 user installation this can be done once for all users on a machine.
76 Specific changes on a per-user base are also possible. 
77 @end itemize
78
79 XXX decribe how to maintain trustlist.txt and /etc/gnupg/trustlist.txt.
80
81
82 ** How to get the ssh support running
83
84 XXX How to use the ssh support.
85
86
87 @section Installation Overview 
88
89 XXXX
90
91