summaryrefslogtreecommitdiff
path: root/README
blob: e2a58ced34df58bcb6ec372ea1a841753a0ab50a (plain)
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
README for minipc-router
========================

Introduction
------------

We have a few mini-pc boxes that we'll be using as routers. The boxes
have an Intel CPU, 8 GiB RAM, 60 GB SSD, four Ethernet ports, and
support for wifi, and where fairly cheap from China. (FIXME: Add
hardware specifics: make, model number, etc.)

This project is about installing and configuring the hardware so that
they work as routers, firewalls, and provide other networking
services.

Image build process
-------------------

Unless you've been given pre-built images, you need to build them
youself. You need:

* Debian (stretch works, jessie might).
* vmdebootstrap

You'll need edit `installer.yaml` and `router.yaml` to set the Debian
mirror URL. `http://httpredir.debian.org/debian` should always work;
the debmirror host is something Lars uses locally for more speed.

You need to configure `authorized_keys` to contain only your own keys.
The default has some other keys. The file is installed to the router
for the `root` user and so those who have the corresponding private
keys can log in as root to the router.

Run

    sudo sh -x build.sh

If this works, it produces `├Čnstaller.img`. This will be put on a USB
stick for installing the router image (`router.img.gz`) to the router
SSD. The router image is included in the installer image.

Installation process
--------------------

The installation process is:

* In the minipc UEFI settings, swich from UEFI+Legacy boot to UEFI only.
* Write the installer image (`installer.img`) to a USB stick with
  `dd`.
* Boot the minipc from the USB stick.
* Log in as root (no password).
* Copy the router system image to the SSD: `zcat /router.img.gz | dd
  of=/dev/sda of=16M` (it'll take a while and there's no progress bar,
  sorry).
* Shutdown the system (run `poweroff`) and remove the USB stick.
* Boot the minipc. This will boot it off the SSD.
* Connect your laptop to the minipc using Ethernet, to the LAN4 port.
  This ports provide DHCP service. is for connecting to the Internet,
  and does not initially have any The other ports do not have network
  configured.
* Log into the minipc as the ansible user (`ssh ansible@10.0.0.4`).
* Use Ansible, or whatever you want, to configure the system to
  provide the services you want. (FIXME: Add the Ansible.)

Note that if you want to re-install the system, you'll need to reboot
from the install USB stick. This may require going to the BIOS/UEFI
and choose the right boot disk.


Legalese
--------

Copyright 2016  Lars Wirzenius, Ivan Dolgov

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

=*= License: GPL-3+ =*=