diff options
Diffstat (limited to 'rpkid/doc/Configuration')
| -rw-r--r-- | rpkid/doc/Configuration | 28 |
1 files changed, 0 insertions, 28 deletions
diff --git a/rpkid/doc/Configuration b/rpkid/doc/Configuration index 1fdccb60..15ebbc1c 100644 --- a/rpkid/doc/Configuration +++ b/rpkid/doc/Configuration @@ -1,5 +1,3 @@ - - ****** Configuration Guide ****** This section describes the configuration file syntax and settings. @@ -13,24 +11,20 @@ specific sections of the configuration file via macro expansion. The configuration file parser supports a limited version of the macro facility used in OpenSSL's configuration parser. An expression such as - foo = ${bar::baz} sets foo to the value of the baz variable from section bar. The section name ENV is special: it refers to environment variables. - ***** myrpki.conf ***** The default name for the shared configuration file is myrpki.conf. - [myrpki] The [myrpki] section of myrpki.conf contains all the parameters that you really need to configure. - # Handle naming hosted resource-holding entity (<self/>) represented # by this myrpki instance. Syntax is an identifier (ASCII letters, # digits, hyphen, underscore -- no whitespace, non-ASCII characters, @@ -44,7 +38,6 @@ globally unique, but should be chosen with an eye towards debugging operational problems: it's best if you use a handle that your parents and children will recognize as being you. - # Names of various files and directories. Don't change these without # a good reason. @@ -61,7 +54,6 @@ intermediate format that it uses. Rather than hardwiring the names into the code, they're configured here. You can change the names if you must, but the defaults should be fine in most cases. - # Whether you want to run your own copy of rpkid (and irdbd). You # want this on unless somebody else is hosting rpkid service for you. @@ -87,7 +79,6 @@ rpkid_server_host parameter here. You may be able to use the default port numbers, or may need to pick different ones. Unless you plan to run irdbd on a different machine from rpkid, you should leave irdbd_server_host alone. - # Whether you want to run your own copy of pubd. In general, it's # best to use your parent's pubd if you can, to reduce the overall # number of publication sites that relying parties need to check, so @@ -120,7 +111,6 @@ information in pubd_contact_info if you plan to offer publication service to your RPKI children, so that grandchildren (or descendents even further down the tree) who receive referrals to your service will know how to contact you. - # Whether you want to run your very own copy of rootd. Don't enable # this unless you really know what you're doing. @@ -138,7 +128,6 @@ test purposes) would be to support certification of private IP addresses and ASNs. The core tools can do this without any problem, but the simplified configuration mechanism does not (yet) make this easy to do. - # Root of local directory tree where pubd (and rootd, sigh) should # write out published data. You need to configure this, and the # configuration should match up with the directory where you point @@ -174,7 +163,6 @@ the directory in which the programs in question were started. In this specific case, it's probably better to use an absolute pathname, since this pathname must also appear in rsyncd.conf. - # SQL configuration. You can ignore this if you're not running any of # the daemons yourself. @@ -210,7 +198,6 @@ default configuration does. If for some reason you need to set different usernames and passwords for different daemons, you can do so by changing the daemon-specific variables. - # Name of OpenSSL binary. You might need to change this if you have # no system copy installed, or if the system copy doesn't support CMS. # The copy of openssl built by this package should suffice. @@ -220,11 +207,9 @@ daemon-specific variables. The myrpki tool uses the openssl command line tool for most of its BPKI operations, for two reasons: - * To avoid duplicating CA-management functionality already provided by the command line tool, and - * To ease portability of the myrpki tool, so that a "hosted" resource holder can use it without needing to install entire toolkit. @@ -237,7 +222,6 @@ you compile the toolkit will suffice. This parameter allows you to tell myrpki where to find the binary, if necessary; the default just uses the system search path. - ***** Other configuration files and options ***** In most cases the simplified configuration in the [myrpki] section of @@ -247,31 +231,19 @@ the configuration file for a program is the name of the program followed by ".conf", and the section name is also named for the program, so that you can combine sections into a single configuration file as shown with myrpki.conf. - * Common_configuration_options - * rpkid_configuration - * irdbd_configuration - * pubd_configuration - * rootd_configuration - * configuration_of_the_smoketest_test_harness - * test_description_language_for_the_smoketest_test_harness Once you've finished with configuration, the next thing you should read is the Operation_Guide. - - - - - |