Skip to content

Commit c957985

Browse files
authored
doc: installation instructions for OpenWRT (scionproto#4559)
1 parent 1e10edb commit c957985

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

doc/manuals/install.rst

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ Installation packages for Debian and derivatives are available for x86-64, arm64
1212
These packages can be found in the `latest release <https://github.com/scionproto/scion/releases/latest>`_.
1313
Packages for in-development versions can be found from the `latest nightly build <https://buildkite.com/scionproto/scion-nightly/builds/latest>`_.
1414

15+
Download and unpack the tar.gz file containing the appropriate .deb packages.
16+
Install all packages with ``apt install ./scion-*.deb``, or install packages for components
17+
selectively, e.g. ``apt install ./scion-router_<version>_<arch>.deb``.
18+
1519
.. warning::
1620

1721
Tests are run only for x86-64. For the other platforms, we cross-compile and don't operate a
@@ -100,6 +104,70 @@ scion-tools
100104
describes the available configuration options.
101105

102106

107+
108+
OpenWRT packages
109+
================
110+
111+
Installation packages for OpenWRT are available for x86-64 (cross-building for other architectures
112+
should be feasible but has not yet been implemented).
113+
114+
These packages can be found in the `latest release <https://github.com/scionproto/scion/releases/latest>`_.
115+
Packages for in-development versions can be found from the `latest nightly build <https://buildkite.com/scionproto/scion-nightly/builds/latest>`_.
116+
117+
Download and unpack the tar.gz file containing the appropriate .ipk packages.
118+
Install all packages with ``opgk install ./scion-*.ipk``, or install packages for components
119+
selectively, e.g. ``opgk install ./scion-router_<version>_<arch>.ipk``.
120+
121+
The packages include init scripts which start the SCION components as part of the OpenWRT boot process.
122+
See the `OpenWRT manual on managing services <https://openwrt.org/docs/guide-user/base-system/managing_services>`_.
123+
124+
.. admonition:: Note
125+
126+
To save space on often storage constrained OpenWRT devices, the relatively large golang
127+
binaries are installed as self-uncompressing, gzipped executables.
128+
129+
Packages
130+
--------
131+
132+
:doc:`scion-control <control>`
133+
:Executable: ``/usr/bin/scion-control``
134+
:Service: ``scion-control``
135+
:Service Configuration File: ``/etc/scion/control.toml``
136+
137+
:doc:`scion-router <router>`
138+
:Executable: ``/usr/bin/scion-router``
139+
:Service: ``scion-router``
140+
:Service Configuration File: ``/etc/scion/router.toml``
141+
142+
:doc:`scion-ip-gateway <gateway>`
143+
:Executable: ``/usr/bin/scion-gateway``
144+
:Service: ``scion-gateway``
145+
:Service Configuration File: ``/etc/scion/gateway.toml``
146+
147+
:doc:`scion-daemon <daemon>`
148+
The scion-daemon and the scion-dispatcher together form the end host SCION stack.
149+
150+
:Executable: ``/usr/bin/scion-daemon``
151+
:Service: ``scion-daemon``
152+
:Service Configuration File: ``/etc/scion/daemon.toml``
153+
154+
:doc:`scion-dispatcher <dispatcher>`
155+
:Executable: ``/usr/bin/scion-dispatcher``
156+
:Service: ``scion-dispatcher``
157+
:Service Configuration File: ``/etc/scion/dispatcher.toml``
158+
159+
scion-tools
160+
The :doc:`scion </command/scion/scion>` and :doc:`scion-pki</command/scion-pki/scion-pki>`
161+
command line tools.
162+
163+
:Executables: ``/usr/bin/scion``, ``/usr/bin/scion-pki``
164+
165+
scion-persistdbs
166+
Helper service to persist databases of ``scion-control`` and ``scion-daemon`` services from volatile storage before shutdown.
167+
At runtime, databases are in volatile storage ``/var/lib/scion``.
168+
For persistence, the files are moved to ``/usr/lib/scion``.
169+
170+
103171
Prebuilt Binaries
104172
=================
105173

0 commit comments

Comments
 (0)