Documentation appreciation

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
-->
1 Like