Debian Codegraph @

docs/install.md

raw
1 # Installation
2
3 The easiest way to install Foomuuri is to use packages from your Linux
4 distribution.
5
6 See [host firewall](example/host-firewall.md) for example `/etc/foomuuri/foomuuri.conf`
7 configuration file.
8
9
10 ## Fedora, RHEL, CentOS Stream
11
12 Foomuuri is included to Fedora and to EPEL.
13
14 ```
15 # Install packages
16 dnf install foomuuri foomuuri-firewalld
17
18 # Configure Foomuuri and verify it
19 $EDITOR /etc/foomuuri/foomuuri.conf
20 foomuuri check
21
22 # Disable and stop current firewall, for example:
23 systemctl disable firewalld.service
24 systemctl disable shorewall.service
25 systemctl disable shorewall6.service
26 systemctl disable shorewall-init.service
27 nft flush ruleset
28
29 # Start Foomuuri
30 systemctl start foomuuri.service
31
32 # Check journal log for firewall logging
33 journalctl --follow --dmesg
34
35 # If everything works, make Foomuuri persistent across reboots
36 systemctl enable foomuuri.service
37 ```
38
39
40 ## Debian, Ubuntu
41
42 Foomuuri is include to Debian sid, forky, trixie (13) and bookworm-backports
43 (12), Ubuntu 23.10 (Mantic) and Ubuntu 24.04 (Noble).
44
45 ```
46 # Install packages
47 apt install foomuuri foomuuri-firewalld
48
49 # Configure Foomuuri and verify it
50 $EDITOR /etc/foomuuri/foomuuri.conf
51 foomuuri check
52
53 # Disable and stop current firewall, for example:
54 systemctl disable firewalld.service
55 systemctl disable shorewall.service
56 systemctl disable shorewall6.service
57 systemctl disable shorewall-init.service
58 nft flush ruleset
59
60 # Start Foomuuri
61 systemctl start foomuuri.service
62
63 # Check journal log for firewall logging
64 journalctl --follow --dmesg
65
66 # If everything works, make Foomuuri persistent across reboots
67 systemctl enable foomuuri.service
68 ```
69
70
71 ## Arch Linux
72
73 Foomuuri is included to Arch User Repository (AUR).
74
75 ```
76 # Build and install packages
77 git clone https://aur.archlinux.org/foomuuri.git
78 cd foomuuri
79 makepkg
80 pacman -U foomuuri-*-x86_64.pkg.tar.zst
81
82 # Configure Foomuuri and verify it
83 $EDITOR /etc/foomuuri/foomuuri.conf
84 foomuuri check
85
86 # Disable and stop current firewall, for example:
87 systemctl disable firewalld.service
88 systemctl disable shorewall.service
89 systemctl disable shorewall6.service
90 systemctl disable shorewall-init.service
91 nft flush ruleset
92
93 # Start Foomuuri
94 systemctl start foomuuri.service
95
96 # Check journal log for firewall logging
97 journalctl --follow --dmesg
98
99 # If everything works, make Foomuuri persistent across reboots
100 systemctl enable foomuuri.service
101 ```
102
103
104 ## Source code
105
106 Source code tarball is available in
107 [releases page](https://github.com/FoobarOy/foomuuri/releases).
108
109 Foomuuri depends on `nftables` (version 1.0.0 or higher, with JSON support
110 enabled) and `python` (version 3.9 or higher). Optional but highly
111 recommended D-Bus support needs `python3-dbus` and `python3-gobject`
112 (called `python3-gi` in some distributions).
113
114 Optionally Foomuuri will use `python3-systemd`, `python3-urllib3` and
115 `python3-lxml` if they are available.
116
117 ```
118 # Untar source
119 tar xf foomuuri-0.??.tar.gz
120 cd foomuuri-0.??
121
122 # Install it to root filesystem
123 make install DESTDIR=/
124 systemctl daemon-reload
125 sysctl --system
126
127 # Configure Foomuuri and verify it
128 $EDITOR /etc/foomuuri/foomuuri.conf
129 foomuuri check
130
131 # Disable and stop current firewall, for example:
132 systemctl disable firewalld.service
133 systemctl disable shorewall.service
134 systemctl disable shorewall6.service
135 systemctl disable shorewall-init.service
136 nft flush ruleset
137
138 # Start Foomuuri
139 systemctl start foomuuri.service
140
141 # Check journal log for firewall logging
142 journalctl --follow --dmesg
143
144 # If everything works, make Foomuuri persistent across reboots
145 systemctl enable foomuuri.service
146 ```