diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e1f533dde14..a9cdfbc0ff9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,10 @@ we can handle the report more easily: the `--noprofile` argument. For example, if `firejail firefox` does not work, please also run `firejail --noprofile firefox` and let us know if it runs correctly or not. -- You may also try disabling various options provided in `/etc/firejail/` until you find out which one causes problems. It will significantly help to find solution for your issue. +- You may also try disabling various options provided in + `/etc/firejail/` until you find out which one causes + problems. + It will significantly help in finding a solution for your issue. Please note: If you are running Debian, Ubuntu, Linux Mint, or another related distribution and you installed firejail from your distro's repositories, please diff --git a/README b/README index 0b235772e6c..fb8737c31fd 100644 --- a/README +++ b/README @@ -1,10 +1,11 @@ -Firejail is a SUID sandbox program that reduces the risk of security -breaches by restricting the running environment of untrusted applications -using Linux namespaces and seccomp-bpf. It includes sandbox profiles for -Iceweasel/Mozilla Firefox, Chromium, Midori, Opera, Evince, Transmission, -VLC, Audacious, Clementine, Rhythmbox, Totem, Deluge, qBittorrent. -DeaDBeeF, Dropbox, Empathy, FileZilla, IceCat, Thunderbird/Icedove, -Pidgin, Quassel, and XChat. +Firejail is a SUID sandbox program that reduces the risk of security breaches +by restricting the running environment of untrusted applications using Linux +namespaces and seccomp-bpf. + +It includes sandbox profiles for many programs, including Iceweasel/Mozilla +Firefox, Chromium, Midori, Opera, Evince, Transmission, VLC, Audacious, +Clementine, Rhythmbox, Totem, Deluge, qBittorrent, DeaDBeeF, Dropbox, Empathy, +FileZilla, IceCat, Thunderbird/Icedove, Pidgin, Quassel, and XChat. Firejail also expands the restricted shell facility found in bash by adding Linux namespace support. It supports sandboxing specific users upon login. @@ -21,28 +22,29 @@ Please report all security vulnerabilities to: * -Compile and install mainline version from GitHub: +Compile and install the mainline version from GitHub: git clone https://github.com/netblue30/firejail.git cd firejail ./configure && make && sudo make install-strip -On Debian/Ubuntu you will need to install git and gcc compiler. AppArmor -development libraries and pkg-config are required when using --enable-apparmor +On Debian/Ubuntu you will need to install git and gcc. AppArmor development +libraries and pkg-config are required when using the --enable-apparmor ./configure option: sudo apt-get install git build-essential libapparmor-dev pkg-config gawk For --selinux option, add libselinux1-dev (libselinux-devel for Fedora). -We build our release firejail.tar.xz and firejail.deb packages using the following command: +We build our release firejail.tar.xz and firejail.deb packages using the +following commands: make distclean && ./configure && make deb Maintainer: - netblue30 (netblue30@protonmail.com) -Committers +Committers: - chiraag-nataraj (https://github.com/chiraag-nataraj) - crass (https://github.com/crass) - ChrysoliteAzalea (https://github.com/ChrysoliteAzalea) @@ -63,9 +65,9 @@ Committers - Vincent43 (https://github.com/Vincent43) - netblue30 (netblue30@protonmail.com) +--- - -Firejail Authors (alphabetical order) +Firejail Authors (alphabetical order): 0x7969 (https://github.com/0x7969) - fix wire-desktop.profile @@ -1255,7 +1257,6 @@ Zack Weinberg (https://github.com/zackw) - support for sandboxing Xpra, Xvfb and Xephyr in independent sandboxes when started with firejail --x11 - support for xpra-extra-params in firejail.config - zupatisc (https://github.com/zupatisc) - patch-util fix diff --git a/README.md b/README.md index a157651c3cd..ab8cca261f4 100644 --- a/README.md +++ b/README.md @@ -139,8 +139,8 @@ cd firejail ./configure && make && sudo make install-strip ``` -On Debian/Ubuntu you will need to install git and gcc compiler. AppArmor -development libraries and pkg-config are required when using `--enable-apparmor` +On Debian/Ubuntu you will need to install git and gcc. AppArmor development +libraries and pkg-config are required when using the `--enable-apparmor` ./configure option: ```sh @@ -186,9 +186,12 @@ The first command solves some shared memory/PID namespace bugs in PulseAudio sof The second command integrates Firejail into your desktop. You would need to logout and login back to apply PulseAudio changes. -Start your programs the way you are used to: desktop manager menus, file manager, desktop launchers. -The integration applies to any program supported by default by Firejail. There are about 250 default applications -in current Firejail version, and the number goes up with every new release. +Start your programs the way you are used to: desktop manager menus, file +manager, desktop launchers. + +The integration applies to any program supported by default by Firejail. +There are over 900 default applications in the current Firejail version, and +the number goes up with every new release. We keep the application list in [src/firecfg/firecfg.config](src/firecfg/firecfg.config)