Ticket #157 (assigned task)

Opened 5 years ago

Last modified 4 years ago

User guide

Reported by: pjf Assigned to: pjf (accepted)
Priority: low Milestone: 3.0
Component: Happy admin Version:
Severity: blocker Keywords:
Cc:

Description (Last modified by pjf)

Well it's high time we started it. Probably it'll be possible to "move" some functionality which we have to implement to documentation, e.g. applying changes made to sytem configuration without rebooting (#156).

A draft of contents:

  • introduction
    • what Lintrack consists of (something like what's a Linux distribution)
    • motiviation and design goals, key concepts
    • current applications (notes about hardware), future goals
  • installation
    • hardware requirements
    • obtaining a CD
    • notes about installing on a CF card
    • general installation instructions
  • configuration rules
    • basic concepts of Flatconf
    • /etc/fc structure
    • using fcc
    • system startup and fc.d parsers
    • custom modifications, possibility of using Lintrack as a generic, polished Linux distro
  • configuration of specific "modules"
    • basic system information - /sys
      • date and time
        • timezone
        • NTP
      • system SSL certificates and PKI support in Lintrack
        • CA.sh script
      • mounting additional disks
      • kernel modules configuration
      • local startup script
    • networking - /net
      • kernel networking settings
      • network interfaces
        • concepts - link layer, IP layer, traffic control configuration
        • Ethernet devices
        • Atheros devices
        • bonding
        • bridging
        • PPP
          • modem connections
          • PPPoE
        • tunelling
          • GRE/IPIP
          • OpenVPN
        • HotSpot? devices
      • static routing
        • simple Internet gateway
        • concept of multitable routing with rules
        • configuring routing tables
        • configuring routing rules
      • DNS system
      • IP packet filtering - generic Lintrack firewall
      • IPSec support
  • network services
    • dnsmasq
    • measurement of network link quality
    • dynamic routing
      • multicast PIMv2 routing
      • OSPFv2
    • SNMP support
    • squid
      • http cache
      • web content filtering
      • ads distribution

I assign the task to 2.1 milestone, hoping that at least part of it could be "implemented" before the release.

I'm not sure how to make the manual up-to-date with successive Lintrack versions, ie. whether we should embed version information in one document, or make separate documents for each Lintrack release.

Change History

02/27/07 21:38:35 changed by pjf

  • priority changed from normal to high.
  • severity changed from major to blocker.

04/30/07 19:50:59 changed by pjf

  • status changed from new to assigned.

Started in r1254.

05/27/07 13:41:06 changed by pjf

  • description changed.

Updated to reflect +- the current structure.

06/10/07 00:04:31 changed by pjf

  • milestone changed from 2.1rc1 to 2.1.

03/15/08 15:49:37 changed by pjf

  • milestone changed from 2.1 to 3.0.

Milestone 2.1 deleted

03/18/08 19:24:48 changed by pjf

  • priority changed from high to low.