aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorLibravatar Kelvin M. Klann <kmk3.code@protonmail.com>2023-03-23 19:34:04 -0300
committerLibravatar Kelvin M. Klann <kmk3.code@protonmail.com>2023-03-26 13:51:25 -0300
commit82eecd4c78c1b0c8097ec165fd9af3dea1a9d859 (patch)
treec79e8b2f72810de253c7e5061c05d5e748f2314c /README
parentdocs: clarify and improve links and items (diff)
downloadfirejail-82eecd4c78c1b0c8097ec165fd9af3dea1a9d859.tar.gz
firejail-82eecd4c78c1b0c8097ec165fd9af3dea1a9d859.tar.zst
firejail-82eecd4c78c1b0c8097ec165fd9af3dea1a9d859.zip
docs: fix misc texts/formatting
Diffstat (limited to 'README')
-rw-r--r--README31
1 files changed, 16 insertions, 15 deletions
diff --git a/README b/README
index 0b235772e..fb8737c31 100644
--- a/README
+++ b/README
@@ -1,10 +1,11 @@
1Firejail is a SUID sandbox program that reduces the risk of security 1Firejail is a SUID sandbox program that reduces the risk of security breaches
2breaches by restricting the running environment of untrusted applications 2by restricting the running environment of untrusted applications using Linux
3using Linux namespaces and seccomp-bpf. It includes sandbox profiles for 3namespaces and seccomp-bpf.
4Iceweasel/Mozilla Firefox, Chromium, Midori, Opera, Evince, Transmission, 4
5VLC, Audacious, Clementine, Rhythmbox, Totem, Deluge, qBittorrent. 5It includes sandbox profiles for many programs, including Iceweasel/Mozilla
6DeaDBeeF, Dropbox, Empathy, FileZilla, IceCat, Thunderbird/Icedove, 6Firefox, Chromium, Midori, Opera, Evince, Transmission, VLC, Audacious,
7Pidgin, Quassel, and XChat. 7Clementine, Rhythmbox, Totem, Deluge, qBittorrent, DeaDBeeF, Dropbox, Empathy,
8FileZilla, IceCat, Thunderbird/Icedove, Pidgin, Quassel, and XChat.
8 9
9Firejail also expands the restricted shell facility found in bash by adding 10Firejail also expands the restricted shell facility found in bash by adding
10Linux namespace support. It supports sandboxing specific users upon login. 11Linux namespace support. It supports sandboxing specific users upon login.
@@ -21,28 +22,29 @@ Please report all security vulnerabilities to:
21 22
22* <netblue30@protonmail.com> 23* <netblue30@protonmail.com>
23 24
24Compile and install mainline version from GitHub: 25Compile and install the mainline version from GitHub:
25 26
26 git clone https://github.com/netblue30/firejail.git 27 git clone https://github.com/netblue30/firejail.git
27 cd firejail 28 cd firejail
28 ./configure && make && sudo make install-strip 29 ./configure && make && sudo make install-strip
29 30
30On Debian/Ubuntu you will need to install git and gcc compiler. AppArmor 31On Debian/Ubuntu you will need to install git and gcc. AppArmor development
31development libraries and pkg-config are required when using --enable-apparmor 32libraries and pkg-config are required when using the --enable-apparmor
32./configure option: 33./configure option:
33 34
34 sudo apt-get install git build-essential libapparmor-dev pkg-config gawk 35 sudo apt-get install git build-essential libapparmor-dev pkg-config gawk
35 36
36For --selinux option, add libselinux1-dev (libselinux-devel for Fedora). 37For --selinux option, add libselinux1-dev (libselinux-devel for Fedora).
37 38
38We build our release firejail.tar.xz and firejail.deb packages using the following command: 39We build our release firejail.tar.xz and firejail.deb packages using the
40following commands:
39 41
40 make distclean && ./configure && make deb 42 make distclean && ./configure && make deb
41 43
42Maintainer: 44Maintainer:
43- netblue30 (netblue30@protonmail.com) 45- netblue30 (netblue30@protonmail.com)
44 46
45Committers 47Committers:
46- chiraag-nataraj (https://github.com/chiraag-nataraj) 48- chiraag-nataraj (https://github.com/chiraag-nataraj)
47- crass (https://github.com/crass) 49- crass (https://github.com/crass)
48- ChrysoliteAzalea (https://github.com/ChrysoliteAzalea) 50- ChrysoliteAzalea (https://github.com/ChrysoliteAzalea)
@@ -63,9 +65,9 @@ Committers
63- Vincent43 (https://github.com/Vincent43) 65- Vincent43 (https://github.com/Vincent43)
64- netblue30 (netblue30@protonmail.com) 66- netblue30 (netblue30@protonmail.com)
65 67
68---
66 69
67 70Firejail Authors (alphabetical order):
68Firejail Authors (alphabetical order)
69 71
700x7969 (https://github.com/0x7969) 720x7969 (https://github.com/0x7969)
71 - fix wire-desktop.profile 73 - fix wire-desktop.profile
@@ -1255,7 +1257,6 @@ Zack Weinberg (https://github.com/zackw)
1255 - support for sandboxing Xpra, Xvfb and Xephyr in independent sandboxes when started 1257 - support for sandboxing Xpra, Xvfb and Xephyr in independent sandboxes when started
1256 with firejail --x11 1258 with firejail --x11
1257 - support for xpra-extra-params in firejail.config 1259 - support for xpra-extra-params in firejail.config
1258
1259zupatisc (https://github.com/zupatisc) 1260zupatisc (https://github.com/zupatisc)
1260 - patch-util fix 1261 - patch-util fix
1261 1262