a5bc7ee829ec507e0c472afd784ba5c838ac7626
[debian/uanytun.git] / README
1 Dependencies
2 ============
3
4 uAnytun can be built by using either libgcrypt or the openssl-crypto library. 
5 The latter is more performant in most cases but there are some license 
6 issues when using this library. It also needs more space when installed.
7
8 Linux
9 -----
10
11 using libgcrypt:
12  
13  build-essential
14  libgcrypt11-dev
15
16 using ssl crypto library:
17
18  build-essential
19  libssl-dev
20
21
22 OpenBSD/FreeBSD
23 ---------------
24
25 using libgcrypt:
26
27  gmake
28  libgcrypt
29  libgpg-error
30
31 using ssl crypto library:
32
33  gmake
34
35
36 Installation
37 ============
38
39 Getting the source via subversion:
40 ----------------------------------
41 svn co https://svn.chaos-at-home.org/uanytun/trunk uanytun
42
43 Building from source
44 --------------------
45
46 using libgcrypt:
47
48 # cd src
49 # ./configure
50 # make
51
52 using ssl crypto library:
53
54 # cd src
55 # ./configure --use-ssl-crypto
56 # make
57
58
59 Notes: 
60   - try './configure --help' for further information
61   - if using openssl pre 0.9.8 you have to disable passphrase
62     because openssl had no SHA256 implementation prior to this
63     version
64   - on OpenBSD/FreeBSD you have to use gmake instead of make
65
66
67 Installing
68 ----------
69
70 # sudo make install
71
72 This will install anytun under the --prefix defined with configure.
73 It also creates a user with name --username  with home --userhome 
74 which can be changed by configure as well.
75
76 Uninstalling
77 ------------
78
79 # sudo make remove
80
81 This removes everytthing except for the config files
82
83 # sudo make purge
84
85 This also removes the config files and deletes the user and it's
86 home directory.