trunk/deployment/README

   1
   2 OpenXPKI Installation
   3
   4 Written by Martin Bartosch for the OpenXPKI project 2006
   5 Copyright (c) 2006 by The OpenXPKI Project
   6
   7 Status: PRELIMINARY (work in progress)
   8
   9
  10 The following command sequence should get you a running OpenXPKI instance.
  11
  12
  13 1 Installation of OpenXPKI core software
  14
  15 1.1 Perl modules
  16
  17 Make sure that the necessary Perl modules are installed:
  18
  19 - required: OpenXPKI core modules
  20 - required: OpenXPKI::Client module
  21 - required: Template, the frontend module to Template::Toolkit
  22 - recommended: OpenXPKI::Client::CLI module
  23 - optional: other client modules as required
  24
  25
  26 1.2 Adminstrative environment
  27
  28 1.2.1 Base configuration (install paths)
  29
  30 $ ./configure [--prefix DIR]
  31
  32 The configure script prepares the main administrative tools for installation.
  33
  34 Optionally the target installation directory can be specified via --prefix.
  35 Any prefix you specify here only influences the installation paths for
  36 the admin tools and the template location.
  37
  38 You can choose the individual installation prefix for your OpenXPKI
  39 instance later during the instance deployment and configuration step.
  40
  41 1.2.2 Installation
  42
  43 $ make && make install
  44
  45 This installs the required shell scripts (daemon start script
  46 and config helper) and the XML configuration templates to the
  47 configured directories.
  48
  49
  50 2 OpenXPKI instance deployment
  51
  52 2.1 Instance creation
  53
  54 $ openxpkiadm deploy [DIR]
  55
  56 The deployment step creates an initial meta-configuration file openxpki.conf
  57 below the specified directory (or in the standard location if no directory
  58 is specified).
  59
  60
  61 2.2 Initial OpenXPKI instance configuration
  62
  63 $ cd ...etc/openxpki
  64 $ openxpki-configure --createdirs
  65
  66 This step will ask the user for PKI details, such as the number
  67 and names of the PKI realms to configure, CA setup, profile etc.
  68 It writes the configuration changes to
  69 ...etc/openxpki/openxpki.conf and creates the XML configuration
  70 files from the settings that were entered.
  71
  72 The --createdirs option tells openxpki-configure to create the instance
  73 specific directories for instance specific data storage (if not specified
  74 it will complain about missing directories).
  75
  76 It is possible to run the command in batch mode via --batch for automated
  77 configuration.
  78 Specifying --force will allow openxpki-configure to overwrite already
  79 existing configuration files.
  80
  81
  82
  83 2.3 Reconfiguration
  84
  85 Inexperienced users or those who are willing to use a simplified
  86 configuration can continue to use the meta configuration in
  87 openxpki.conf, apply changes there and generate the XML files
  88 from the templates. The XML configuration files will be overwritten
  89 by this procedure.
  90
  91 To do this, repeat the procedure outlined in the previous section and
  92 run:
  93
  94    $ cd .../etc/openxpki
  95    $ ./openxpki-configure --force
  96
  97 NOTE that this will overwrite the XML files in this directory!
  98
  99 Advanced users will probably choose not to use the meta configuration
 100 and modify the XML files directly:
 101
 102    $ cd .../etc/openxpki
 103    $ rm -f openxpki.conf
 104    $ vi config.xml token.xml ...
 105
 106
 107
 108 3. Database setup
 109
 110 In order to initialize the database run
 111
 112 $ openxpkiadm initdb
 113
 114
 115
 116 4. Running the server
 117
 118 You can start OpenXPKI by running
 119
 120 $ openxpkictl start
 121
 122 To stop the daemon use
 123
 124 $ openxpkictl stop
 125