aboutsummaryrefslogtreecommitdiff
path: root/doc/03.RPKI.Installation.FreeBSDPorts.wiki
blob: bff99b78b197e78b68a698561f5ec66226dc77aa (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
[[TracNav(doc/RPKI/TOC)]]
[[PageOutline]]

= Installation Using FreeBSD Ports =

Port skeletons are available for FreeBSD from download.rpki.net.  To
use these, you need to download the port skeletons then run them using
your favorite FreeBSD port installation tool.

== Manual Download ==

To download the port skeletons manually and install from them, do
something like this:

{{{
#!sh
for port in rpki-rp rpki-ca
do
  fetch https://download.rpki.net/FreeBSD_Packages/${port}-port.tgz
  tar xf ${port}-port.tgz
  cd ${port}
  make install
  cd ..
  rm -rf ${port}
done
}}}

After performing initial installation, you should customize the
default `rpki.conf` for your environment as necessary.  In particular,
you want to change `handle` and `rpkid_server_host`.  There are
[[CA/Configuration|obsessively detailed instructions]].

{{{
#!sh
emacs /usr/local/etc/rpki.conf
}}}

Again, you want to change `handle` and `rpkid_server_host` at the minimum.

To upgrade, you can perform almost the same steps, but the FreeBSD
ports system, which doesn't really know about upgrades, will require
you to use the `deinstall` and `reinstall` operations instead of plain
`install`:

{{{
#!sh
for port in rpki-rp rpki-ca
do
  fetch https://download.rpki.net/FreeBSD_Packages/${port}-port.tgz
  tar xf ${port}-port.tgz
  cd ${port}
  make deinstall
  make reinstall
  cd ..
  rm -rf ${port}
done
}}}

After an upgrade, you may want to check the newly-installed
`/usr/local/etc/rpki.conf.sample` against your existing
`/usr/local/etc/rpki.conf` in case any important options have changed.
We generally try to keep options stable between versions, and provide
sane defaults where we can, but if you've done a lot of customization
to your `rpki.conf` you will want to keep track of this.

== Automated Download and Install with portmaster ==

There's a
[[https://download.rpki.net/FreeBSD_Packages/rpki-portmaster.sh|script]]
you can use to automate the download steps above and perform the
updates using portmaster.  First, download the script:

{{{
#!sh
fetch https://download.rpki.net/FreeBSD_Packages/rpki-portmaster.sh
}}}

Then, to install or upgrade, just execute the script:

{{{
#!sh
sh rpki-portmaster.sh
}}}

As with manual download (above) you should customize `rpki.conf` after
initial installation.

== Automated Download and Install with portupgrade ==

There's a
[[https://download.rpki.net/FreeBSD_Packages/rpki-portupgrade.sh|script]]
you can use to automate the download steps above and perform the
updates using portupgrade.  First, download the script:

{{{
#!sh
fetch https://download.rpki.net/FreeBSD_Packages/rpki-portupgrade.sh
}}}

Next, you will need to add information about the RPKI ports to two
variables in `/usr/local/etc/pkgtools.conf` before portupgrade will
know how to deal with these ports:

{{{
#!ruby
EXTRA_CATEGORIES = [
    'rpki',
]

ALT_INDEX = [
    ENV['PORTSDIR'] + '/INDEX.rpki',
]
}}}

Once you have completed these steps, you can just execute the script
to install or upgrade the RPKI code:

{{{
#!sh
sh rpki-portupgrade.sh
}}}

As with manual download (above) you should customize `rpki.conf` after
initial installation.