Verified Commit 68a67224 authored by Karel Koci's avatar Karel Koci 🤘 Committed by Lukas Jelinek

Add board and competency labels

This adds board and competency labels to almost all articles. Articles
that are general or are just descriptive (no action needed) are left
out.

Data collection setup was split to separate article.
Also Shield was added to few places.
parent d0bfcc5e
Pipeline #71983 passed with stages
in 1 minute and 12 seconds
---
board: mox, omnia, 1.x
competency: intermediate
---
# Network boot of Turris MOX
This article will guide you through setting up your Turris MOX as an AP
......
---
board: shield, mox, omnia, 1.x
competency: novice
---
# Netmetr
## What is Netmetr?
......
---
board: shield, mox, omnia, 1.x
competency: novice
---
# OpenVPN server on Turris
Starting with Turris OS 3.6, you can configure OpenVPN easily through the Foris web interface.
......
---
board: mox, omnia, 1.x
competency: intermediate
---
# PaKon - Network monitoring (Parental Control)
## What is Pakon?
......
---
board: shield, mox, omnia, 1.x
---
# Sentinel
## What is Sentinel?
......@@ -8,9 +11,12 @@ exchange.
## Installation & first run
To use Sentinel on Turris device just have to follow the instructions in [_How
to set up data collection?_](../collect/collect.md#how-to-set-up-data-collection) chapter
in the [data collection](../collect/collect.md) documentation.
!!! tip
Data collection system is installed out of the box on [Turris
Shield](../../models/#turris-shield). There is no need to configure it.
To use Sentinel on Turris device just have to follow the instructions in the [date
collection setup](../collect/setup.md) article.
During the installation, the system tries to obtain Sentinel client
certificate and starts to collect the data. New firewall rules
......
---
board: shield, mox, omnia, 1.x
---
# Data Collection
One of the initial motives that led to the development of the Turris router was
......@@ -92,36 +95,3 @@ could be seen on [HaaS project website](https://haas.nic.cz).
Sadly, there is currently no way to visualize what your own router collects from
Firewall monitoring and Minipots - a feature we are working hard on now.
## How to set up data collection?
The whole functionality is nowadays provided by [Sentinel](../apps/sentinel.md).
You just need to enable the _Data Collection_ package list in the
_Package Management_ tab and agree with our
[EULA](https://gitlab.nic.cz/turris/sentinel/eula/-/blob/master/eulas/1.txt)
via _Data Collection_ tab in reForis. This will install and enable
[dynamic firewall](dynfw/collect-dynfw.md) and other selected data collection
components.
![Package Sentinel](reforis-pkg-sentinel.png)
![EULA](reforis-collect-eula.png)
You can also install the data collection manually using command line (SSH):
```
opkg update
opkg install turris-survey sentinel-dynfw-client sentinel-nikola sentinel-minipot haas-proxy
uci set sentinel.main.agreed_with_eula_version=1 && uci commit
```
In both cases, few extra steps are needed to activate HaaS:
1. Register on our website - [HaaS.nic.cz](https://haas.nic.cz).
2. There, in section _My Honeypot_ click on _Add new device_. After
naming it, you will get a **token**
![HaaS Device](haas-device.png)
3. Add your token to the router using command line (SSH):
```
uci set haas.settings.token="YOUR_TOKEN"
uci commit
/etc/init.d/haas-proxy start
```
---
board: shield, mox, omnia, 1.x
---
# Dynamic Firewall
The dynamic firewall (A.K.A. DynFW) is Turris IDS and IPS system - the tool for
......
---
board: mox, omnia, 1.x
competency: novice
---
## How to set up data collection?
The whole functionality is nowadays provided by [Sentinel](../apps/sentinel.md).
You just need to enable the _Data Collection_ package list in the
_Package Management_ tab and agree with our
[EULA](https://gitlab.nic.cz/turris/sentinel/eula/-/blob/master/eulas/1.txt)
via _Data Collection_ tab in reForis. This will install and enable
[dynamic firewall](dynfw/collect-dynfw.md) and other selected data collection
components.
![Package Sentinel](reforis-pkg-sentinel.png)
![EULA](reforis-collect-eula.png)
You can also install the data collection manually using command line (SSH):
```
opkg update
opkg install turris-survey sentinel-dynfw-client sentinel-nikola sentinel-minipot haas-proxy
uci set sentinel.main.agreed_with_eula_version=1 && uci commit
```
In both cases, few extra steps are needed to activate HaaS:
1. Register on our website - [HaaS.nic.cz](https://haas.nic.cz).
2. There, in section _My Honeypot_ click on _Add new device_. After
naming it, you will get a **token**
![HaaS Device](haas-device.png)
3. Add your token to the router using command line (SSH):
```
uci set haas.settings.token="YOUR_TOKEN"
uci commit
/etc/init.d/haas-proxy start
```
---
board: mox
---
# First setup of Turris MOX (CPU Only)
This page is written for users who would like to configure their MOX device with
......
---
board: mox
---
# First setup of Turris MOX
## Before you start
......
---
board: shield
---
# First setup of Turris Shield
## Connecting cables
......
---
board: omnia, 1.x
---
# First setup on Turris 1.X and Omnia
Both Turris 1.X and Omnia were produced in several batches and the actual
......
---
board: mox, omnia, 1.x
competency: novice
---
# DNS settings in Foris
## What is DNS?
......
---
board: mox, omnia, 1.x
competency: novice
---
# Guest network
There are some situations when you want to allow Internet access to some other people (your guests, visitors,
......
---
board: mox, omnia, 1.x
competency: novice
---
# Accessing Foris via HTTPS
If you see warning box bellow in your Foris web interface, you should add a
......
---
board: mox, omnia, 1.x
competency: novice
---
# LAN settings in Foris
This section contains settings for the local network (LAN). The provided defaults are suitable for most networks.
......
---
board: mox, omnia, 1.x
competency: intermediate
---
# Storage plugin
Turris contains an eMMC flash memory card which is used as the system storage. It holds both the Turris OS itself
......
---
board: mox, omnia, 1.x
competency: novice
---
# WAN settings in Foris
Here you specify your WAN port settings. Usually, you can leave this options untouched unless instructed otherwise by
......
---
board: mox, omnia, 1.x
---
# Interesting features to try
If you are new to Turris project, there is plenty of stuff that can be done with
......
---
board: mox, omnia, 1.x
competency: intermediate
---
# LuCI
## What is LuCI?
......
---
board: mox, omnia, 1.x
competency: intermediate
---
# Static IP addresses assignment
Static DHCP server addresses assignment is useful when it's required that devices, connected to your network, will get
......
---
board: shield, mox, omnia, 1.x
---
# reForis
## What is reForis
......
---
board: shield, mox, omnia, 1.x
---
# reForis Screenshots
## Router overview
......
......@@ -3,13 +3,13 @@ Turris OS software is being released as a fixed set of packages for given versio
## History of major Turris OS versions
| Major Turris OS version | OpenWrt version | Released | Support terminated | Compatible routers |
|-------------------------|-----------------------------|-----------|--------------------|---------------------------------------------------------------------------|
| 1.x.x | 12.09 (Attitude Adjustment) | ~1.2.2014 | 17.2.2015 | [Turris 1.x](models.md#turris-1x) |
| 2.x.x | 14.07 (Barrier Breaker) | 17.2.2015 | 24.5.2016 | [Turris 1.x](models.md#turris-1x) |
| 3.x.x | 15.05 (Chaos Calmer) | 24.5.2016 | - | [Turris 1.x](models.md#turris-1x), [Omnia](models.md#turris-omnia) |
| 4.x.x | 18.06 | 5.10.2019 | 4.6.2020 | [Turris 1.x](models.md#turris-1x), [Omnia](models.md#turris-omnia), [Mox](models.md#turris-mox) |
| 5.x.x | 19.07 | 4.6.2020 | - | [Turris 1.x](models.md#turris-1x), [Omnia](models.md#turris-omnia), [Mox](models.md#turris-mox) |
| Major Turris OS version | OpenWrt version | Released | Support terminated | Compatible routers |
|-------------------------|-----------------------------|-----------|--------------------|------------------------------------------------------------------------------------------------------------------------------------|
| 1.x.x | 12.09 (Attitude Adjustment) | ~1.2.2014 | 17.2.2015 | [Turris 1.x](models.md#turris-1x) |
| 2.x.x | 14.07 (Barrier Breaker) | 17.2.2015 | 24.5.2016 | [Turris 1.x](models.md#turris-1x) |
| 3.x.x | 15.05 (Chaos Calmer) | 24.5.2016 | - | [Turris 1.x](models.md#turris-1x), [Omnia](models.md#turris-omnia) |
| 4.x.x | 18.06 | 5.10.2019 | 4.6.2020 | [Turris 1.x](models.md#turris-1x), [Omnia](models.md#turris-omnia), [Mox](models.md#turris-mox) |
| 5.x.x | 19.07 | 4.6.2020 | - | [Turris 1.x](models.md#turris-1x), [Omnia](models.md#turris-omnia), [Mox](models.md#turris-mox), [Shield](models.md#turris-shield) |
For more detailed list of changes and versions history please see
[changelog](changelog.md).
......@@ -82,6 +82,7 @@ These are Turris OS versions flashed in factory and routers they were flashed to
| 4.0-beta1 | Turris Mox (early campaign SD cards) |
| 4.0.0 | Turris Mox (late campaign SD cards and early distribution) |
| 4.0.1 | Turris Mox (late 2019 distribution) and Turris Omnia (CZ11NIC23) |
| 5.1.0 | Turris Shield |
[^1]: Turris 1.x were originally sent out with Turris OS versions before 3.0 but
because of DNS root key rollover there was a need to force update factory
......
---
competency: advanced
---
# Creating issues
If you think that our software contains a bug or if you would like to request
......
---
competency: expert
---
# Submitting pull requests
If you have created a bug fix or an improvement for our software you can
......
---
competency: expert
---
# Turris project coding style
All code accepted to the Turris project must have convenient quality.
......
---
competency: novice
---
# How to Participate in the Interface Translation
We developed the Turris router interface in English and we use Czech as the
......
---
board: mox, omnia
competency: advanced
---
# LXC on Turris
......
---
board: mox, omnia, 1.x
competency: intermediate
---
# Nextcloud server on Turris
## What is Nextcloud?
......
---
board: mox, omnia, 1.x
competency: intermediate
---
# Schnapps
## What is Schnapps?
......
---
board: mox, omnia, 1.x
competency: advanced
---
# How to try future releases of Turris OS?
Do you want to contribute to better stability of Turris OS? Or would you just
......
---
board: omnia, 1.x
competency: intermediate
---
# Migration from Turris OS 3.x
Update from Turris OS 3.x to 5.0 or newer is big leap. There is more than three
years of significant development in OpenWrt. At the same time with this Turris
......
---
board: mox
---
# Add-ons
Add-ons are specific accessory that can extend functionality of Turris MOX but
......
---
board: mox
---
# MOX Hardware details
MOX is an unique network device. It contains usual set of
......
---
board: mox
---
# About
![Turris MOX](mox.jpg)
......
---
board: mox
competency: advanced
---
# Preparation of microSD card for Turris MOX
## Using rescue modes
......
---
board: mox
---
# MOX A (Basic)
## Key features
......
---
board: mox
---
# MOX B (Extension)
## Key features
......
---
board: mox
---
# MOX C (Ethernet)
## Key features
......
---
board: mox
---
# MOX D (SFP)
## Key features
......
---
board: mox
---
# MOX E (Super Ethernet)
## Key features
......
---
board: mox
---
# MOX F (USB)
## Key features
......
---
board: mox
---
# MOX G (Super Extension)
## Key features
......
---
board: mox
---
# Factory reset on Turris MOX
The Turris MOX router has a multifunction button on its back panel. When you
......
---
board: mox
competency: expert
---
# Booting Turris MOX over serial
!!! warning
......
---
board: mox
---
# MOX Classic
The most demanded configuration of Turris MOX router. Marvell Armada 3720 1 GHz
......
---
board: mox
---
# MOX Pocket Wi-Fi
A basic configuration of the Turris MOX router with Wi-Fi. Marvell Armada 3720
......
---
board: mox
---
# MOX Power Wi-Fi
A configuration of the Turris MOX router with two Wi-Fi cards. Marvell Armada
......
---
board: mox
---
# MOX Start
A basic configuration of the Turris MOX router. Marvell Armada 3720 1 GHz dual
......
---
board: omnia
---
# Turris Omnia
Turris Omnia is powerful SOHO router. It is based on **Marvel Armada 385 CPU** -
......
---
board: omnia
---
# Factory reset on Turris Omnia
The Turris Omnia router has a reset button on its back panel. When you press
......
---
board: omnia
---
# Turris Omnia revisions
Turris Omnia router received during its manufacturing and public sale various
......
---
board: omnia
competency: expert
---
# Booting Turris Omnia over serial
!!! warning
......
---
board: mox, omnia, 1.x
competency: advanced
---
# Serial connection
!!! warning
......
---
board: shield
---
# Turris Shield screenshots
## Router overview
......
---
board: shield
---
# Turris Shield
![Turris Shield](shield.png)
......
---
board: 1.x
---
# Turris 1.0/1.1
Turris 1.X is a powerful router that was part of Turris security research
......
......@@ -14,4 +14,4 @@ badge-omnia" title="Turris Omnia">Omnia</a>
{% if "1.x" in page.meta.board %}
<a href="https://docs.turris.cz/basics/models/#turris-1x" class="badge
badge-turris" title="Turris 1.x">1.x</a>
{% endif %}
\ No newline at end of file
{% endif %}
......@@ -69,6 +69,7 @@ nav:
- Data Collection:
- Introduction: 'basics/collect/collect.md'
- Dynamic Firewall: 'basics/collect/dynfw/collect-dynfw.md'
- Setup: 'basics/collect/setup.md'
- Foris:
- 'Secure access': 'basics/foris/https/https.md'
- LAN: 'basics/foris/lan/foris-lan.md'
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment