Debian Codegraph @

README

raw
1 #
2 # Copyright (C) 2010-2026 Red Hat, Inc. All rights reserved.
3 #
4 # Author: Fabio M. Di Nitto <[email protected]>
5 #
6 # This software licensed under GPL-2.0+
7 #
8
9 Upstream resources
10 ------------------
11
12 https://github.com/kronosnet/kronosnet/
13 https://ci.kronosnet.org/
14 https://projects.clusterlabs.org/project/board/86/ (TODO list and activities tracking)
15 https://drive.google.com/drive/folders/0B_zxAPgZTkM_TklfYzN6a2FYUFE?resourcekey=0-Cfr5D94rZ8LVbeMPGjxbdg&usp=sharing (google shared drive)
16 https://lists.kronosnet.org/mailman3/postorius/lists/users.lists.kronosnet.org/
17 https://lists.kronosnet.org/mailman3/postorius/lists/devel.lists.kronosnet.org/
18 https://lists.kronosnet.org/mailman3/postorius/lists/commits.lists.kronosnet.org/
19 https://kronosnet.org/ (web 0.1 style)
20 IRC: #kronosnet on Libera.Chat
21
22 Architecture
23 ------------
24
25 Please refer to the google shared drive Presentations directory for
26 diagrams and fancy schemas
27
28 Dependancies
29 ------------
30 kronosnet has few obligatory dependancies, though it is strongly recommended
31 that you build it with at least one crypto library enabled.
32
33 It does, however, require libqb for both the doxygen2man tool (for creating
34 the API man pages) and headers for list manipulation.
35 You can get these from installing libqb from source or libqb-devel package, and
36 your distro might provide doxgen2man as its own package.
37
38 Running on FreeBSD
39 -----------------------
40
41 knet requires big socket buffers and you need to set:
42 kern.ipc.maxsockbuf=18388608
43 in /etc/sysctl.conf or knet will fail to run.
44
45 For version 12 (or lower), knet requires also:
46 net.inet.sctp.blackhole=1
47 in /etc/sysctl.conf or knet will fail to work with SCTP.
48 This sysctl is obsoleted in version 13.
49
50 libnozzle requires if_tap.ko loaded in the kernel.
51
52 Please avoid to use ifconfig_DEFAULT in /etc/rc.conf to use
53 DHCP for all interfaces or the dhclient will interfere with
54 libnozzle interface management, causing errors on some
55 operations such as "ifconfig tap down".
56
57 Building on Solaris / Illumos
58 -----------------------------
59
60 tested on SunOS openindiana-x86-64 5.11 illumos-5b6ecd7fe9:
61
62 # pkg install autoconf automake libtool pkg-config \
63 gcc-14 gnu-binutils gnu-coreutils gnu-make \
64 check system/mozilla-nss doxygen \
65 header-tun tun
66
67 optional:
68
69 # pkg install developer/clang-20
70
71 GNU tools must be preferred:
72
73 # export PATH=/usr/gnu/bin:$PATH
74
75 mozilla-nss is currently broken in oi-userland and does not ship pkg-config files
76
77 # ./autogen.sh && ./configure --disable-crypto-nss
78
79 # make all -j && make check
80
81 Running on Solaris / Illumos
82 ----------------------------
83
84 Tune socket buffers for the protocol you intend to use:
85
86 ipadm set-prop -p max_buf=8388608 sctp
87 ipadm set-prop -p max_buf=8388608 udp