man/ipsilon-server-install.1

   1 .\" Copyright (C) 2015 Ipsilon Project Contributors
   2 .\"
   3 .TH "ipsilon-server-install" "1" "1.1.0" "Ipsilon" "Ipsilon Manual Pages"
   4 .SH "NAME"
   5 ipsilon\-server\-install \- Configure an Ipsilon Identity Provider instance
   6 .SH "SYNOPSIS"
   7 ipsilon\-server\-install [OPTION]...
   8 .SH "DESCRIPTION"
   9 Configure an Ipsilon instance to provide identity services using any of the supported and enabled protocols.
  10
  11 Ipsilon uses a plugable framework so some options may not be available, depending on what plugins have been installed.
  12
  13 Ipsilon supports three types of plugins:
  14
  15 1. Authentication provider plugins \- implements an authentication protocol such as SAML 2, OpenID or Persona. At least one needs to be enabled.
  16 .br
  17 2. Login plugins \- mechanisms for authenticating including GSSAPI, LDAP, PAM, etc. At least one should be enabled.
  18 .br
  19 3. Info plugins \- sources where additional attributes of the user may be obtained.
  20 .br
  21
  22 There are also environment helper options which aid in configuring the Identity Provider for a particular environment, such as a FreeIPA domain.
  23
  24 The installation details are logged to /var/log/ipsilon\-install.log.
  25 .SH "DATABASES"
  26 Ipsilon stores configuration and session information in database tables. By default, a set of sqlite databases are used. If a full RDBMS is desired then the \fB\-\-database\-url\fR and/or \fB*\-dburi\fR options can be used to provide the database URIs. This should probably be used in load\-balanced situations so all servers can use the same database.
  27
  28 An example of a specific URI is
  29 .br
  30 \-\-users_dburi=postgresql://@dbserver.example.com:45432/users
  31
  32 The templatized version would be
  33 .br
  34 \-\-database\-url=postgresql://@dbserver.example.com:45432/%(dbname)s
  35 .SH "OPTIONS"
  36 .SS BASIC OPTIONS
  37 .TP
  38 \fB\-h\fR, \fB\-\-help\fR
  39 Show this help message and exit
  40 .TP
  41 \fB\-\-version\fR
  42 Show program's version number and exit
  43 .TP
  44 \fB\-o\fR \fILM_ORDER\fR, \fB\-\-login\-managers\-order\fR \fILM_ORDER\fR
  45 Comma separated list of login managers
  46 .TP
  47 \fB\-\-hostname\fR \fIHOSTNAME\fR
  48 The hostname used by clients to reach this instance. This is used to determine the URLs provided in SAML metadata
  49 .TP
  50 \fB\-\-instance\fR \fIINSTANCE\fR
  51 Ipsilon instance name
  52 .TP
  53 \fB\-\-system\-user\fR \fISYSTEM_USER\fI
  54 User account used to run the server
  55 .TP
  56 \fB\-\-admin\-user\fR \fIADMIN_USER\fR
  57 User account that is assigned Ipsilon admin privileges
  58 .TP
  59 \fB\-\-database\-url\fR \fIDATABASE_URL\fR
  60 The (templatized) database URL to use
  61 .TP
  62 \fB\-\-secure\fR
  63 Boolean to turn on all security checks
  64 .TP
  65 \fB\-\-server\-debugging\fR
  66 Enable debugging
  67 .TP
  68 \fB\-\-uninstall\fR
  69 Uninstall the server and all data
  70 .TP
  71 \fB\-\-yes\fR
  72 Always answer yes
  73 .TP
  74 \fB\-\-admin\-dburi\fR \fIADMIN_DBURI\fR
  75 Configuration database URI (override template)
  76 .TP
  77 \fB\-\-users\-dburi \fIUSERS_DBURI\fR
  78 User configuration database URI (override template)
  79 .TP
  80 \fB\-\-transaction\-dburi\fR \fITRANSACTION_DBURI\fR
  81 Transaction database URI (override template)
  82 .SS AUTHENTICATION PROVIDER OPTIONS
  83 .TP
  84 \fB\-\-openid\fR
  85 Configure OpenID Provider
  86 .TP
  87 \fB\-\-openid\-dburi\fR \fIOPENID_DBURI\fR
  88 OpenID database URI (override template)
  89 .TP
  90 \fB\-\-persona\fR
  91 Configure Persona Provider
  92 .TP
  93 \fB\-\-saml2\fR
  94 Configure SAML2 Provider
  95 .TP
  96 \fB\-\-saml2\-metadata\-validity\fR \fISAML2_METADATA_VALIDITY\fR
  97 Metadata validity period in days (default \- 1825)
  98
  99 .SS LOGIN MANAGER OPTIONS
 100 .TP
 101 \fB\-\-form\fR
 102 Configure External Form authentication
 103 .TP
 104 \fB\-\-form\-service\fR \fIFORM_SERVICE\fR
 105 PAM service name to use for authentication
 106 .TP
 107 \fB\-\-fas\fR
 108 Configure FAS (Fedora Authentication System) authentication
 109 .TP
 110 \fB\-\-ldap\fR
 111 Configure LDAP authentication
 112 .TP
 113 \fB\-\-ldap\-server\-url\fR \fILDAP_SERVER_URL\fR
 114 LDAP Server Url
 115 .TP
 116 \fB\-\-ldap\-bind\-dn\-template\fR \fILDAP_BIND_DN_TEMPLATE\fR
 117 LDAP Bind DN Template
 118 .TP
 119 \fB\-\-ldap\-tls\-level\fR \fILDAP_TLS_LEVEL\fR
 120 LDAP TLS level
 121 .TP
 122 \fB\-\-ldap\-base\-dn\fR \fILDAP_BASE_DN\fR
 123 LDAP Base DN
 124 .TP
 125 \fB\-\-krb\fR
 126 Configure Kerberos authentication
 127 .TP
 128 \fB\-\-krb\-httpd\-keytab\fR \fIKRB_HTTPD_KEYTAB\fR
 129 Kerberos keytab location for HTTPD
 130 .TP
 131 \fB\-\-pam\fR
 132 Configure PAM authentication
 133 .TP
 134 \fB\-\-pam\-service\fR \fIPAM_SERVICE\fR
 135 PAM service name to use for authentication
 136 .TP
 137 \fB\-\-testauth\fR
 138 Configure testing environment authentication
 139
 140 .SS INFO PROVIDER OPTIONS
 141 \fB\-\-info\-ldap\fR
 142 Use LDAP to populate user attrs
 143 .TP
 144 \fB\-\-info\-ldap\-server\-url\fR \fIINFO_LDAP_SERVER_URL\fR
 145 LDAP Server Url
 146 .TP
 147 \fB\-\-info\-ldap\-bind\-dn\fR \fIINFO_LDAP_BIND_DN\fR
 148 LDAP Bind DN
 149 .TP
 150 \fB\-\-info\-ldap\-bind\-pwd\fR \fIINFO_LDAP_BIND_PWD\fR
 151 LDAP Bind Password
 152 .TP
 153 \fB\-\-info\-ldap\-user\-dn\-template\fR \fIINFO_LDAP_USER_DN_TEMPLATE\fR
 154 LDAP User DN Template
 155 .TP
 156 \fB\-\-info\-ldap\-base\-dn\fR \fIINFO_LDAP_BASE_DN\fR
 157 LDAP Base DN
 158 .TP
 159 \fB\-\-info\-nss\fR
 160 Use passwd data to populate user attrs
 161 .TP
 162 \fB\-\-info\-sssd\fR \fI
 163 Use mod_lookup_identity and SSSD to populate user attrs. SSSD must be pre\-configured for at least one domain.
 164 .TP
 165 \fB\-\-info\-sssd\-domain\fR \fIINFO_SSSD_DOMAIN\fR
 166 SSSD domain to enable mod_lookup_identity for (default is all)
 167
 168 .SS ENVIRONMENT HELPER OPTIONS
 169 \fB\-\-ipa\fR
 170 Helper for IPA joined machines. This configures Ipsilon for Kerberos authentication.
 171 .SH "EXIT STATUS"
 172 0 if the installation was successful
 173
 174 1 if an error occurred
 175 .SH "SEE ALSO"
 176 .BR ipsilon(7),
 177 .BR ipsilon\-client\-install(1)