diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/doc.RPKI.Installation | 7 | ||||
-rw-r--r-- | doc/doc.RPKI.Installation.DebianPackages | 67 | ||||
-rw-r--r-- | doc/doc.RPKI.Installation.FromSource | 24 | ||||
-rw-r--r-- | doc/doc.RPKI.RP | 8 | ||||
-rw-r--r-- | doc/manual.pdf | bin | 754837 -> 755338 bytes |
5 files changed, 87 insertions, 19 deletions
diff --git a/doc/doc.RPKI.Installation b/doc/doc.RPKI.Installation index d7ceae33..1c8047c4 100644 --- a/doc/doc.RPKI.Installation +++ b/doc/doc.RPKI.Installation @@ -3,10 +3,11 @@ There are a few different ways to install the RPKI code, depending on what the platform on which you're trying to install. -* On Ubuntu 12.04 LTS, you can use Ubuntu binary packages. +* On Ubuntu 12.04 LTS ("Precise Pangolin") or Debian 7 ("Wheezy"), you can use + Debian binary packages. - At present we only generate binary packages for 12.04 LTS - ("precise"). This may change in the future. + At present we only generate binary packages for Precise Pangolin and + Wheezy. This may change in the future. * On FreeBSD, you can use FreeBSD ports. diff --git a/doc/doc.RPKI.Installation.DebianPackages b/doc/doc.RPKI.Installation.DebianPackages new file mode 100644 index 00000000..44ae0945 --- /dev/null +++ b/doc/doc.RPKI.Installation.DebianPackages @@ -0,0 +1,67 @@ +****** Installation Using Debian Packages on Debian and Ubuntu Systems ****** + +Precompiled binary packages for Ubuntu 12.04 LTS ("Precise Pangolin") and +Debian 7 ("Wheezy") are available from download.rpki.net using the Debian +Advanced Package Tools (APT). To use these, you need to configure APT on your +machine to know about our APT repository, but once you've done this you should +be able to install and update these packages like any other precompiled +package. + +***** Initial APT Setup ***** + +You should only need to perform these steps once for any particular machine. + +* Add the GPG public key for this repository (optional, but APT will whine + unless you do this): + + wget -q -O - http://download.rpki.net/APT/apt-gpg-key.asc | sudo apt-key + add - + +* Configure APT to use this repository (for Ubuntu systems): + + sudo wget -q -O /etc/apt/sources.list.d/rpki.list http://download.rpki.net/ + APT/rpki.ubuntu.list + +* Configure APT to use this repository (for Debian systems): + + sudo wget -q -O /etc/apt/sources.list.d/rpki.list http://download.rpki.net/ + APT/rpki.debian.list + +***** Installation Using APT Tools ***** + +These instructions assume that you're using apt-get. Other APT tools such as +aptitude should also work. + +* Update available packages: + + sudo apt-get update + +* Install the software: + + sudo apt-get install rpki-rp rpki-ca + +* Customize the default rpki.conf for your environment as necessary. In + particular, you want to change handle and rpkid_server_host. There are + obsessively detailed instructions. + + sudo emacs /etc/rpki.conf + + Again, you want to change handle and rpkid_server_host at the + minimum. + +* If you changed anything in rpki.conf, you should restart the RPKI CA service: + + sudo initctl restart rpki-ca + +***** Upgrading ***** + +Once you've performced the steps above you should be able to upgrade to newer +version of the code using the normal APT upgrade process, eg: + + sudo apt-get update + sudo apt-get upgrade + +Or, if you only want to update the RPKI tools: + + sudo apt-get update + sudo apt-get upgrade diff --git a/doc/doc.RPKI.Installation.FromSource b/doc/doc.RPKI.Installation.FromSource index 8e7888e4..1adea8d4 100644 --- a/doc/doc.RPKI.Installation.FromSource +++ b/doc/doc.RPKI.Installation.FromSource @@ -15,7 +15,7 @@ The CA tools have a few additional dependencies, described below. Note that initial development of this code has been on FreeBSD, so installation will probably be easiest on FreeBSD. We do, however, test on other platforms, -such as Fedora, Ubuntu, and MacOSX. +such as Fedora, Ubuntu, Debian, and MacOSX. ***** Downloading the Source Code ***** @@ -56,7 +56,7 @@ Packages you will need: # /usr/ports/lang/python27 (python) - o Ubuntu: + o Debian & Ubuntu: # python # python-dev @@ -69,7 +69,7 @@ Packages you will need: o FreeBSD: /usr/ports/devel/py-lxml (py27-lxml) o Fedora: python-lxml.i386 - o Ubuntu: + o Debian & Ubuntu: # python-lxml # libxml2-utils @@ -87,7 +87,7 @@ Packages you will need: # /usr/ports/databases/mysql55-server (mysql55-server) # /usr/ports/databases/mysql55-client (mysql55-client) - o Ubuntu: + o Debian & Ubuntu: # mysql-client # mysql-server @@ -97,12 +97,13 @@ Packages you will need: o FreeBSD: /usr/ports/databases/py-MySQLdb (py27-MySQLdb) o Fedora: MySQL-python.i386 - o Ubuntu: python-mysqldb + o Debian & Ubuntu: python-mysqldb * http://www.djangoproject.com/, the Django web user interface toolkit. The GUI interface to the CA tools requires this. Django 1.4 is required. o FreeBSD: /usr/ports/www/py-django (py27-django) + o Debian: python-django o Ubuntu: Do not use the python-django package (Django 1.3.1) in 12.04 LTS, as it is known not to work. Instead, install a recent version using easy_install or pip: @@ -113,7 +114,7 @@ Packages you will need: The GUI uses this to parse the payload of RPKI Ghostbuster objects. o FreeBSD: /usr/ports/deskutils/py-vobject (py27-vobject) - o Ubuntu: python-vobject + o Debian & Ubuntu: python-vobject * Several programs (more as time goes on) use the Python argparse module. This module is part of the Python standard library as of Python 2.7, but you may @@ -127,13 +128,13 @@ Packages you will need: description of a simulated allocation hierarchy to test. o FreeBSD: /usr/ports/devel/py-yaml (py27-yaml) - o Ubuntu: python-yaml + o Debian & Ubuntu: python-yaml * http://xmlsoft.org/XSLT/. Some of the test code uses xsltproc, from the Gnome LibXSLT package. o FreeBSD: /usr/ports/textproc/libxslt (libxslt) - o Ubuntu: xsltproc + o Debian & Ubuntu: xsltproc * http://www.rrdtool.org/. The relying party tools use this to generate graphics which you may find useful in monitoring the behavior of your @@ -141,18 +142,19 @@ Packages you will need: won't be able to generate those graphics. o FreeBSD: /usr/ports/databases/rrdtool (rrdtool) - o Ubuntu: rrdtool + o Debian & Ubuntu: rrdtool * http://www.freshports.org/www/mod_wsgi3/ If you intend to run the GUI with wsgi, its default configuration, you will need to install mod_wsgi v3 o FreeBSD: /usr/ports/www/mod_wsgi3 (app22-mod_wsgi) - o Ubuntu: libapache2-mod-wsgi + o Debian & Ubuntu: libapache2-mod-wsgi * http://south.aeracode.org/ Django South 0.7.6 or later. This tool is used to ease the pain of changes to the web portal database schema. o FreeBSD: /usr/ports/databases/py-south (py27-south) + o Debian: python-django-south o Ubuntu: Do not use the python-django-south 0.7.3 package in 12.04 LTS, as it is known not to work. Instead, install a recent version using easy_install or pip: @@ -241,7 +243,7 @@ listed here for completeness. notably Graphviz, pdfLaTeX, and Ghostscript. o FreeBSD: /usr/ports/devel/doxygen - o Ubuntu: doxygen + o Debian & Ubuntu: doxygen * http://www.mbayer.de/html2text/. The documentation build process uses xsltproc and html2text to dump flat text versions of a few critical diff --git a/doc/doc.RPKI.RP b/doc/doc.RPKI.RP index 1f7ff4d0..e42b9185 100644 --- a/doc/doc.RPKI.RP +++ b/doc/doc.RPKI.RP @@ -8,17 +8,15 @@ BGP security. See the CA tools for programs to help you generate RPKI objects, if you need to do that. -The RP main tools are `rcynic` and `rtr-origin`, each of which is discussed -below. +The RP main tools are rcynic and rtr-origin, each of which is discussed below. The installation process sets up everything you need for a basic RPKI validation installation. You will, however, need to think at least briefly about which RPKI trust anchors you are using, and may need to change these from the defaults. -The installation process sets up a cron job running running [#rcynic- -cron|`rcynic-cron` as user "rcynic" once per hour at a randomly-selected -minute. +The installation process sets up a cron job running running rcynic-cron as user +"rcynic" once per hour at a randomly-selected minute. ***** rcynic ***** diff --git a/doc/manual.pdf b/doc/manual.pdf Binary files differindex 79defe72..b6f4fd68 100644 --- a/doc/manual.pdf +++ b/doc/manual.pdf |