Documentation restructuring: provide a useful overview.
[tripe] / manual / intro.texi
CommitLineData
2c1261e5
MW
1@c
2@c Introduction to TrIPE
3@c
4@c (c) 2009 Straylight/Edgeware
5@c
6
7@c --------------------------------------------------------------------------
8@node Introduction, hack
9@unnumbered Introduction
10
11This chapter explains very briefly what TrIPE is and what this manual
12aims to tell you about it.
13
14@menu
15* About TrIPE:: What TrIPE is and what it does
16* About this manual:: What this manual tries to do, and who
17 should read it
18@end menu
19
20@node About TrIPE, About this manual, Introduction, Introduction
21@unnumberedsec About TrIPE
22
23TrIPE is a TrIPE is a Virtual Private Network (VPN) implementation. It uses
24cryptography to protect network packets from being read or tampered with
25as they travel over hostile networks (e.g., the Internet). The effect
26of this is that you can connect together geographically-separated
27networks of machines and use network protocols which would be unsafe to
28use over public networks.
29
30The name `TrIPE' stands for `Trivial IP Encryption'. Unfortunately,
31while the TrIPE network protocol is still fairly simple (and this is one
32of TrIPE's conspicuous advantages over other VPN systems), the software
33suite which implements it is not. Over time, the original single server
34has acquired strangely-shaped extensions and add-on-services in order to
35solve various problems, and even given fairly detailed descriptions of
36all of the individual pieces it can be difficult to see how to fit them
37together in order to actually do anything useful.
38
39The TrIPE software runs entirely in user mode. It does not require any
40kernel modifications.
41
42@node About this manual, , About TrIPE, Introduction
43@unnumberedsec About this manual
44
45This manual provides an overview of the TrIPE software suite. The
46individual components are described in their respective reference manual
47pages. This page exists to provide a picture for how the various pieces
48fit together and how to use them effectively. It presents a number of
49worked examples, but it's not intended to be used as a `cookbook'; TrIPE
50is a complicated system, and the author believes that you're less likely
51to become confused by it if you understand how its various bits fit
52together rather than following canned recipes which don't quite match
53your particular circumstances.
54
55This manual is intended for network administrators who are comfortable
56with the fundamentals of IP networking and routing. It assumes a
57reasonable level of knowledge of how to configure network interfaces and
58routing. It doesn't assume a strong background in cryptography, though
59a good grounding won't hurt; the author recommends the @cite{Handbook of
60Applied Cryptography} by Alfred Menezes, Paul van Oorschott and Scott
61Vanstone, which is published by CRC Press, or available online at
62@url{http://FIXME}.
63
64Unlike other Info manuals, this one isn't intended to be a complete
65reference to the system. That information is provided in traditional
66Unix-style manual pages, which are easier to consult quickly. Instead,
67it provides a conceptual overview of the system together with examples
68to help you get started.
69
70@node hack, , Introduction
71@chapter magic
72
73@c ----- That's all, folks --------------------------------------------------
74\f
75@c Local variables:
76@c mode: Texinfo
77@c TeX-PDF-mode: t
78@c TeX-master: "tripe"
79@c End: