diff options
author | RPKI Documentation Robot <docbot@rpki.net> | 2013-06-04 03:00:25 +0000 |
---|---|---|
committer | RPKI Documentation Robot <docbot@rpki.net> | 2013-06-04 03:00:25 +0000 |
commit | 2262ef7dae4eeeb21cd7c7eb11ded64212b88a0c (patch) | |
tree | eee85a194243b7bd0884e41a4c5238f582f119f0 | |
parent | 81bf607697068896a7d872cb9ae62aa6cde7052d (diff) |
Automatic pull of documentation from Wiki.
svn path=/trunk/; revision=5361
-rw-r--r-- | doc/doc.RPKI.CA.Configuration.irdbd | 28 | ||||
-rw-r--r-- | doc/doc.RPKI.CA.Configuration.pubd | 63 | ||||
-rw-r--r-- | doc/doc.RPKI.CA.Configuration.rootd | 98 | ||||
-rw-r--r-- | doc/doc.RPKI.CA.Configuration.rpkid | 64 | ||||
-rw-r--r-- | doc/manual.pdf | bin | 634059 -> 654517 bytes |
5 files changed, 123 insertions, 130 deletions
diff --git a/doc/doc.RPKI.CA.Configuration.irdbd b/doc/doc.RPKI.CA.Configuration.irdbd index cf4098a1..9d00d0b6 100644 --- a/doc/doc.RPKI.CA.Configuration.irdbd +++ b/doc/doc.RPKI.CA.Configuration.irdbd @@ -9,39 +9,39 @@ end's SQL database, and thus is able to pull its own BPKI configuration directly from the database, and thus needs a bit less configuration than the other daemons. -sql-database:: +***** sql-database ***** - MySQL database name for irdbd. +MySQL database name for irdbd. sql-database = ${myrpki::irdbd_sql_database} -sql-username:: +***** sql-username ***** - MySQL user name for irdbd. +MySQL user name for irdbd. sql-username = ${myrpki::irdbd_sql_username} -sql-password:: +***** sql-password ***** - MySQL password for irdbd. +MySQL password for irdbd. sql-password = ${myrpki::irdbd_sql_password} -server-host:: +***** server-host ***** - Host on which irdbd should listen for HTTP service requests. +Host on which irdbd should listen for HTTP service requests. server-host = ${myrpki::irdbd_server_host} -server-port:: +***** server-port ***** - Port on which irdbd should listen for HTTP service requests. +Port on which irdbd should listen for HTTP service requests. server-port = ${myrpki::irdbd_server_port} -startup-message:: +***** startup-message ***** - String to log on startup, useful when debugging a collection of irdbd - instances at once. +String to log on startup, useful when debugging a collection of irdbd instances +at once. - No default value. +No default value. diff --git a/doc/doc.RPKI.CA.Configuration.pubd b/doc/doc.RPKI.CA.Configuration.pubd index de00e02a..312e74c0 100644 --- a/doc/doc.RPKI.CA.Configuration.pubd +++ b/doc/doc.RPKI.CA.Configuration.pubd @@ -4,75 +4,72 @@ pubd's default configuration file is the system rpki.conf file. Start pubd with -c filename to choose a different configuration file. All options are in the section [pubd]. BPKI certificates and keys may be either DER or PEM format. -sql-database:: +***** sql-database ***** - MySQL database name for pubd. +MySQL database name for pubd. sql-database = ${myrpki::pubd_sql_database} -sql-username:: +***** sql-username ***** - MySQL user name for pubd. +MySQL user name for pubd. sql-username = ${myrpki::pubd_sql_username} -sql-password:: +***** sql-password ***** - MySQL password for pubd. +MySQL password for pubd. sql-password = ${myrpki::pubd_sql_password} -publication-base:: +***** publication-base ***** - Root of directory tree where pubd should write out published data. - You need to configure this, and the configuration should match up - with the directory where you point rsyncd. Neither pubd nor rsyncd - much cares -where- you tell them to put this stuff, the important - thing is that the rsync URIs in generated certificates match up with - the published objects so that relying parties can find and verify - rpkid's published outputs. +Root of directory tree where pubd should write out published data. You need to +configure this, and the configuration should match up with the directory where +you point rsyncd. Neither pubd nor rsyncd much cares -where- you tell them to +put this stuff, the important thing is that the rsync URIs in generated +certificates match up with the published objects so that relying parties can +find and verify rpkid's published outputs. publication-base = ${myrpki::publication_base_directory} -server-host:: +***** server-host ***** - Host on which pubd should listen for HTTP service requests. +Host on which pubd should listen for HTTP service requests. server-host = ${myrpki::pubd_server_host} -server-port:: +***** server-port ***** - Port on which pubd should listen for HTTP service requests. +Port on which pubd should listen for HTTP service requests. server-port = ${myrpki::pubd_server_port} -bpki-ta:: +***** bpki-ta ***** - Where pubd should look for the BPKI trust anchor. All BPKI - certificate verification within pubd traces back to this trust - anchor. Don't change this unless you really know what you are doing. +Where pubd should look for the BPKI trust anchor. All BPKI certificate +verification within pubd traces back to this trust anchor. Don't change this +unless you really know what you are doing. bpki-ta = ${myrpki::bpki_servers_directory}/ca.cer -pubd-cert:: +***** pubd-cert ***** - Where pubd should look for its own BPKI EE certificate. Don't change - this unless you really know what you are doing. +Where pubd should look for its own BPKI EE certificate. Don't change this +unless you really know what you are doing. pubd-cert = ${myrpki::bpki_servers_directory}/pubd.cer -pubd-key:: +***** pubd-key ***** - Where pubd should look for the private key corresponding to its own - BPKI EE certificate. Don't change this unless you really know what - you are doing. +Where pubd should look for the private key corresponding to its own BPKI EE +certificate. Don't change this unless you really know what you are doing. pubd-key = ${myrpki::bpki_servers_directory}/pubd.key -irbe-cert:: +***** irbe-cert ***** - Where pubd should look for the back-end control client's BPKI EE - certificate. Don't change this unless you really know what you are - doing. +Where pubd should look for the back-end control client's BPKI EE certificate. +Don't change this unless you really know what you are doing. irbe-cert = ${myrpki::bpki_servers_directory}/irbe.cer diff --git a/doc/doc.RPKI.CA.Configuration.rootd b/doc/doc.RPKI.CA.Configuration.rootd index 87a2290c..ebb93d71 100644 --- a/doc/doc.RPKI.CA.Configuration.rootd +++ b/doc/doc.RPKI.CA.Configuration.rootd @@ -22,126 +22,124 @@ rootd's default configuration file is the system rpki.conf file. Start rootd with -c filename to choose a different configuration file. All options are in the section [rootd]. Certificates and keys may be in either DER or PEM format. -bpki-ta:: +***** bpki-ta ***** - Where rootd should look for the BPKI trust anchor. All BPKI - certificate verification within rootd traces back to this trust - anchor. Don't change this unless you really know what you are doing. +Where rootd should look for the BPKI trust anchor. All BPKI certificate +verification within rootd traces back to this trust anchor. Don't change this +unless you really know what you are doing. bpki-ta = ${myrpki::bpki_servers_directory}/ca.cer -rootd-bpki-crl:: +***** rootd-bpki-crl ***** - BPKI CRL. Don't change this unless you really know what you are - doing. +BPKI CRL. Don't change this unless you really know what you are doing. rootd-bpki-crl = ${myrpki::bpki_servers_directory}/ca.crl -rootd-bpki-cert:: +***** rootd-bpki-cert ***** - rootd's own BPKI EE certificate. Don't change this unless you really - know what you are doing. +rootd's own BPKI EE certificate. Don't change this unless you really know what +you are doing. rootd-bpki-cert = ${myrpki::bpki_servers_directory}/rootd.cer -rootd-bpki-key:: +***** rootd-bpki-key ***** - Private key corresponding to rootd's own BPKI EE certificate. Don't - change this unless you really know what you are doing. +Private key corresponding to rootd's own BPKI EE certificate. Don't change this +unless you really know what you are doing. rootd-bpki-key = ${myrpki::bpki_servers_directory}/rootd.key -child-bpki-cert:: +***** child-bpki-cert ***** - BPKI certificate for rootd's one and only up-down child (RPKI engine - to which rootd issues an RPKI certificate). Don't change this unless - you really know what you are doing. +BPKI certificate for rootd's one and only up-down child (RPKI engine to which +rootd issues an RPKI certificate). Don't change this unless you really know +what you are doing. child-bpki-cert = ${myrpki::bpki_servers_directory}/child.cer -server-host:: +***** server-host ***** - Server host on which rootd should listen. +Server host on which rootd should listen. server-host = ${myrpki::rootd_server_host} -server-port:: +***** server-port ***** - Server port on which rootd should listen. +Server port on which rootd should listen. server-port = ${myrpki::rootd_server_port} -rpki-root-dir:: +***** rpki-root-dir ***** - Where rootd should write its output. Yes, rootd should be using pubd - instead of publishing directly, but it doesn't. This needs to match - pubd's configuration. +Where rootd should write its output. Yes, rootd should be using pubd instead of +publishing directly, but it doesn't. This needs to match pubd's configuration. rpki-root-dir = ${myrpki::publication_base_directory} -rpki-base-uri:: +***** rpki-base-uri ***** - rsync URI corresponding to directory containing rootd's outputs. +rsync URI corresponding to directory containing rootd's outputs. rpki-base-uri = rsync://${myrpki::publication_rsync_server}/${myrpki:: publication_rsync_module}/ -rpki-root-cert-uri:: +***** rpki-root-cert-uri ***** - rsync URI for rootd's root (self-signed) RPKI certificate. +rsync URI for rootd's root (self-signed) RPKI certificate. rpki-root-cert-uri = rsync://${myrpki::publication_rsync_server}/${myrpki:: publication_root_module}/root.cer -rpki-root-key:: +***** rpki-root-key ***** - Private key corresponding to rootd's root RPKI certificate. +Private key corresponding to rootd's root RPKI certificate. rpki-root-key = ${myrpki::bpki_servers_directory}/root.key -rpki-root-cert:: +***** rpki-root-cert ***** - Filename (as opposed to rsync URI) of rootd's root RPKI certificate. +Filename (as opposed to rsync URI) of rootd's root RPKI certificate. rpki-root-cert = ${myrpki::publication_root_cert_directory}/root.cer -rpki-subject-pkcs10:: +***** rpki-subject-pkcs10 ***** - Where rootd should stash a copy of the PKCS #10 request it gets from - its one (and only) child +Where rootd should stash a copy of the PKCS #10 request it gets from its one +(and only) child rpki-subject-pkcs10 = ${myrpki::bpki_servers_directory}/rootd.subject.pkcs10 -rpki-subject-lifetime:: +***** rpki-subject-lifetime ***** - Lifetime of the one and only RPKI certificate rootd issues. +Lifetime of the one and only RPKI certificate rootd issues. rpki-subject-lifetime = 30d -rpki-root-crl:: +***** rpki-root-crl ***** - Filename (relative to rootd-base-uri and rpki-root-dir) of the CRL - for rootd's root RPKI certificate. +Filename (relative to rootd-base-uri and rpki-root-dir) of the CRL for rootd's +root RPKI certificate. rpki-root-crl = root.crl -rpki-root-manifest:: +***** rpki-root-manifest ***** - Filename (relative to rootd-base-uri and rpki-root-dir) of the - manifest for rootd's root RPKI certificate. +Filename (relative to rootd-base-uri and rpki-root-dir) of the manifest for +rootd's root RPKI certificate. rpki-root-manifest = root.mft -rpki-class-name:: +***** rpki-class-name ***** - Up-down protocol class name for RPKI certificate rootd issues to its - one (and only) child. +Up-down protocol class name for RPKI certificate rootd issues to its one (and +only) child. rpki-class-name = ${myrpki::handle} -rpki-subject-cert:: +***** rpki-subject-cert ***** - Filename (relative to rootd-base-uri and rpki-root-dir) of the one - (and only) RPKI certificate rootd issues. +Filename (relative to rootd-base-uri and rpki-root-dir) of the one (and only) +RPKI certificate rootd issues. rpki-subject-cert = ${myrpki::handle}.cer diff --git a/doc/doc.RPKI.CA.Configuration.rpkid b/doc/doc.RPKI.CA.Configuration.rpkid index c31f70f5..5ce68be4 100644 --- a/doc/doc.RPKI.CA.Configuration.rpkid +++ b/doc/doc.RPKI.CA.Configuration.rpkid @@ -1,81 +1,79 @@ ****** [rpkid] section ****** -rpkid's default config file is the system rpkid.conf file. Start rpkid with - +rpkid's default config file is the system rpki.conf file. Start rpkid with - c filename to choose a different config file. All options are in the section [rpkid]. BPKI Certificates and keys may be in either DER or PEM format. -sql-database:: +***** sql-database ***** - MySQL database name for rpkid. +MySQL database name for rpkid. sql-database = ${myrpki::rpkid_sql_database} -sql-username:: +***** sql-username ***** - MySQL user name for rpkid. +MySQL user name for rpkid. sql-username = ${myrpki::rpkid_sql_username} -sql-password:: +***** sql-password ***** - MySQL password for rpkid. +MySQL password for rpkid. sql-password = ${myrpki::rpkid_sql_password} -server-host:: +***** server-host ***** - Host on which rpkid should listen for HTTP service requests. +Host on which rpkid should listen for HTTP service requests. server-host = ${myrpki::rpkid_server_host} -server-port:: +***** server-port ***** - Port on which rpkid should listen for HTTP service requests. +Port on which rpkid should listen for HTTP service requests. server-port = ${myrpki::rpkid_server_port} -irdb-url:: +***** irdb-url ***** - HTTP service URL rpkid should use to contact irdbd. If irdbd is - running on the same machine as rpkid, this can and probably should be - a loopback URL, since nobody but rpkid needs to talk to irdbd. +HTTP service URL rpkid should use to contact irdbd. If irdbd is running on the +same machine as rpkid, this can and probably should be a loopback URL, since +nobody but rpkid needs to talk to irdbd. irdb-url = http://${myrpki::irdbd_server_host}:${myrpki::irdbd_server_port}/ -bpki-ta:: +***** bpki-ta ***** - Where rpkid should look for the BPKI trust anchor. All BPKI - certificate verification within rpkid traces back to this trust - anchor. Don't change this unless you really know what you are doing. +Where rpkid should look for the BPKI trust anchor. All BPKI certificate +verification within rpkid traces back to this trust anchor. Don't change this +unless you really know what you are doing. bpki-ta = ${myrpki::bpki_servers_directory}/ca.cer -rpkid-cert:: +***** rpkid-cert ***** - Where rpkid should look for its own BPKI EE certificate. Don't change - this unless you really know what you are doing. +Where rpkid should look for its own BPKI EE certificate. Don't change this +unless you really know what you are doing. rpkid-cert = ${myrpki::bpki_servers_directory}/rpkid.cer -rpkid-key:: +***** rpkid-key ***** - Where rpkid should look for the private key corresponding to its own - BPKI EE certificate. Don't change this unless you really know what - you are doing. +Where rpkid should look for the private key corresponding to its own BPKI EE +certificate. Don't change this unless you really know what you are doing. rpkid-key = ${myrpki::bpki_servers_directory}/rpkid.key -irdb-cert:: +***** irdb-cert ***** - Where rpkid should look for irdbd's BPKI EE certificate. Don't change - this unless you really know what you are doing. +Where rpkid should look for irdbd's BPKI EE certificate. Don't change this +unless you really know what you are doing. irdb-cert = ${myrpki::bpki_servers_directory}/irdbd.cer -irbe-cert:: +***** irbe-cert ***** - Where rpkid should look for the back-end control client's BPKI EE - certificate. Don't change this unless you really know what you are - doing. +Where rpkid should look for the back-end control client's BPKI EE certificate. +Don't change this unless you really know what you are doing. irbe-cert = ${myrpki::bpki_servers_directory}/irbe.cer diff --git a/doc/manual.pdf b/doc/manual.pdf Binary files differindex 5f1a1a01..d7bbff3d 100644 --- a/doc/manual.pdf +++ b/doc/manual.pdf |