Documentation appreciation

manuals
documentation

#1

We are working on improving and expanding our documentation and we would greatly appreciate your feedback. If you have any comments about a specific article/manual or you simply have a less specific comment, please post it here. Also suggestions on specific topics, which would interest you, are very much valued. :bulb: :blue_heart:


#2

Control the speed of a pwm fan.
Adblocking with knot.


#3

Is there a way to see which documentation has changed? If not, that would be nice.


#4

Hello,
Yes, there is.

for English documentation: https://www.turris.cz/doc/en/start?do=recent
for Czech documentation: https://www.turris.cz/doc/cs/start?do=recent


#5

I’m looking at (and for) documentation and have some thoughts on the sort of manual I’d like to see. I’d be willing to help put that together.

For starters, there’s the general framework of such a discussion. I’ve started with a Markdown outline that seems to make sense to me, and would appreciate feedback from both users and the team.

I’m tracking this locally under git, and could push that repo someplace.

There’s an associated build system (rather MacOS / OSX-centric presently) that will produce ~20 or so endpoints, including HTML, ePub, and PDF.

---
title: "Turris Omnia Administration Manual"
author: Dr. Edward Morbius
...



# Introduction

## Goal of this chapter


## Review



# Overview


## Goal of this chapter


## Wireless Routers


## The Project:  About Turris


## The Hardware:  About the Omnia


## The Organisation:  About CZ.NIC


## About OpenWRT


## About GNU/Linux


## Updates


## Cautions


## Alternative WiFi/Router Solutions

Features, advantages, disadvantages.


### Proprietary Routers

### OpenWRT

### DD-WRT

### Tomato

## Review



# Administration Interfaces

## Goal of this chapter



## Back Up and Restore


## Factory Reset


## Basic Configuration:  Foris


## OpenWRT Configuration:  LuCi


## Shell configuration

### SSH

### Shell

### opkg


## Review



# System Overview

## Goal of this chapter



## Services


## Standard Packages


## Data Collection


## Review



# Packages and Projects


## Goal of this chapter


## Print Server


## Ad Blocking / DNS hackery


## Firewall


## File Server


## Review



# Software Hacking


## Goal of this chapter


## Turris


## OpenWRT


## Build Environment


## Cross-Compiling


## Review



# Physical Hacking


## Goal of this chapter


## Review


# Appendices


# Raw Notes

## Services

From: <https://doc.turris.cz/doc/en/howto/start>

* Root access (SSH)
* OpenVPN setup via command line
* OpenVPN plugin - a quick and easy setup in Foris
* NAS
* Boot over a network
* Sharing a printer
* Wake on LAN
* Majordomo - data transfer statistics
* Failover to LTE using mwan3
* Minipot - small honeypots
* SSH honeypot
* How to work with LXC containers
* Schnapps - snapshot tool
* Nextcloud
* Delayed updates
* PaKon - Parental Control

## Network Settings

* Configuring internal VLANs - Turris 1.0 & 1.1
* Configuring internal VLANs - Turris Omnia
* DNS
* Guest Wi-Fi
* Basic Wi-Fi settings


## "Specialties"

* GPIO (general purpose input-output ports)
* How to test Turris OS branches and releases
* LED diodes
* Transparently Routing Traffic Through Tor
* Using a USB camera
* Sound card
* DVB on Turris routers
* Turris OS compilation from source code
* Installation of the LTE modem on Turris Omnia
* What processes are running on the Turris router


## Troubleshooting

* Factory Reset
* Debugging DNS
* Serial Link
* Bug Tracking
    * Known bugs
    * Error reporting
* User support forums
* Documentation





<!--
vim: tw=0 linebreak nolist wrap ft=markdown ic
-->

#6

Hi and thanks for your helpful input! Just wanted to let you know that your outline looks reasonable and I’m excited to learn more, will get back to you next week with some more specific feedback. :innocent:


#7

Thanks.

I’m plugging bits into the outline. It’s also something that’s a starting point, and I’ve nothing against re-organising that into something more workable / appropriate, including hiving off bits that might be best addressed elsewhere.

I’m also approaching this as very much new-to-Turris, though been-around-Tech (and Linux/Unix/Networking specifically) Far Too Long.


#8

I think really helpful would be official statement on SFP-interface:
Which SFP-modules are supported for what internetprovider?
What has to be configured and how?


#9

I don’t think that Turris team can really make any official statements about what internet providers support, as that’s completely out of their control, but I expect it wouldn’t be hard to compose a list of SFP modules they successfully tried (and the corresponding configuration).


#10

Hi,
what I know we have explicit support for only 1000BASE-X and SGMII based modules, but you can also try 100 based modules.

We have confirmed that these SFP modules work
S.B1312.10.DL
S.B1512.10.DL

sometimes it’s necessary to set speed non-negotiate as it is stated here

But if you have some issue with SFP modules, don’t hesitate and contact us on this e-mail tech.support(at)turris.cz


#11

@Pepe Would be good to have that information centralised - @vcunat is right, one would need information back from community, which modules they used. Perhaps that can be done via survey.

I do not need that info right now but hope to get fibre soon and therefore deem it really valuable (for anyone in the same situation).


#12

I have two propositions for changes/updates in the official documentation:

  1. https://doc.turris.cz/doc/en/howto/network_boot#installing_and_configuring_the_required_tools
    After "Set the sharing of the directory with the installation images for the netboot in the file /etc/exports: "
    Would be nice to add command to apply & test settings afterwards:
    exportfs -rv

  2. https://doc.turris.cz/doc/en/howto/led_settings#setting_the_intensity
    it says that rainbow intensity command takes values from 0 to 7. But according to rainbow help:
    ‘intensity’ NUMBER, where:
    NUMBER is number from 0 to 100 (percent of maximum brightness).

    I guess that just changed with some update. The same change needs to go to:
    https://doc.turris.cz/doc/en/howto/led_settings#automatic_overnight_dimming
    For the proposed cron job, ex:
    MAILTO=""
    * * * * * root /usr/bin/rainbow_button_sync.sh
    0 7 * * * root rainbow intensity 100
    0 22 * * * root rainbow intensity 50
    0 23 * * * root rainbow intensity 30
    0 24 * * * root rainbow intensity 10

EDIT:
3. In the https://doc.turris.cz/doc/en/howto/turris_os_build
There is something about file vagrant/vagrant_bootstrap.sh and in i you can find build dependencies. I just pulled the sources and there is only vagrant/vagrant_provision.sh

Always helpfull to make changes myself if needed :slight_smile:


#13

Can you please provide clear documented steps for configuring Turris Omnia as a network switch?