aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Kelvin M. Klann <kmk3.code@protonmail.com>2023-03-26 04:26:59 -0300
committerLibravatar Kelvin M. Klann <kmk3.code@protonmail.com>2023-03-26 13:52:11 -0300
commita516247a1c2715b98c8b6281cbd76d5399f51540 (patch)
tree41053cf10af48caa759768eac14ab209b6016bd0
parentdocs: line-wrap some long lines (diff)
downloadfirejail-a516247a1c2715b98c8b6281cbd76d5399f51540.tar.gz
firejail-a516247a1c2715b98c8b6281cbd76d5399f51540.tar.zst
firejail-a516247a1c2715b98c8b6281cbd76d5399f51540.zip
docs: line-wrap markdown and use double-spacing
Use two spaces to separate sentences to make the source easier to read in monospace fonts (such as when editing or reviewing it), especially for longer paragraphs. The HTML output should still look the same. Misc: This also removes source-level ambiguity regarding abbreviations (such as "Mr.") vs the end of sentences and enables moving between sentences in vi with `(` and `)`, for example.
-rw-r--r--.github/pull_request_template.md2
-rw-r--r--CONTRIBUTING.md15
-rw-r--r--README4
-rw-r--r--README.md50
4 files changed, 38 insertions, 33 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index ecc5be304..4a7998e87 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -7,7 +7,7 @@ following:
7- The ordering of options follow the rules described in 7- The ordering of options follow the rules described in
8 [etc/templates/profile.template](../blob/master/etc/templates/profile.template) 8 [etc/templates/profile.template](../blob/master/etc/templates/profile.template)
9 (/usr/share/doc/firejail/profile.template when installed). 9 (/usr/share/doc/firejail/profile.template when installed).
10- Order the arguments of options alphabetically. You can easily do this with 10- Order the arguments of options alphabetically. You can easily do this with
11 [sort.py](../blob/master/contrib/sort.py). 11 [sort.py](../blob/master/contrib/sort.py).
12 12
13 The path to it depends on your distro: 13 The path to it depends on your distro:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ebc4d3a20..1ae293264 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -15,17 +15,18 @@ a comment in our dedicated issue:
15When submitting a bug report, please provide the following information so that 15When submitting a bug report, please provide the following information so that
16we can handle the report more easily: 16we can handle the report more easily:
17 17
18- firejail version. If you're not sure, open a terminal and type `firejail --version`. 18- firejail version. If you're not sure, open a terminal and type `firejail
19 --version`.
19- Linux distribution (so that we can try to reproduce it, if necessary). 20- Linux distribution (so that we can try to reproduce it, if necessary).
20- If you know that the problem did not exist in an earlier version of firejail, please mention it. 21- If you know that the problem did not exist in an earlier version of firejail,
21- If you are reporting that a program does not work with firejail, please also run firejail with 22 please mention it.
22 the `--noprofile` argument. 23- If you are reporting that a program does not work with firejail, please also
23 For example, if `firejail firefox` does not work, please also run `firejail --noprofile firefox` and 24 run firejail with the `--noprofile` argument. For example, if `firejail
25 firefox` does not work, please also run `firejail --noprofile firefox` and
24 let us know if it runs correctly or not. 26 let us know if it runs correctly or not.
25- You may also try disabling various options provided in 27- You may also try disabling various options provided in
26 `/etc/firejail/<ProgramName.profile>` until you find out which one causes 28 `/etc/firejail/<ProgramName.profile>` until you find out which one causes
27 problems. 29 problems. It will significantly help in finding a solution for your issue.
28 It will significantly help in finding a solution for your issue.
29 30
30Please note: If you are running Debian, Ubuntu, Linux Mint, or another related 31Please note: If you are running Debian, Ubuntu, Linux Mint, or another related
31distribution and you installed firejail from your distro's repositories, please 32distribution and you installed firejail from your distro's repositories, please
diff --git a/README b/README
index 9833e078e..0d402a854 100644
--- a/README
+++ b/README
@@ -8,7 +8,7 @@ Clementine, Rhythmbox, Totem, Deluge, qBittorrent, DeaDBeeF, Dropbox, Empathy,
8FileZilla, IceCat, Thunderbird/Icedove, Pidgin, Quassel, and XChat. 8FileZilla, IceCat, Thunderbird/Icedove, Pidgin, Quassel, and XChat.
9 9
10Firejail also expands the restricted shell facility found in bash by adding 10Firejail also expands the restricted shell facility found in bash by adding
11Linux namespace support. It supports sandboxing specific users upon login. 11Linux namespace support. It supports sandboxing specific users upon login.
12 12
13Download: https://sourceforge.net/projects/firejail/files/ 13Download: https://sourceforge.net/projects/firejail/files/
14Build and install: ./configure && make && sudo make install 14Build and install: ./configure && make && sudo make install
@@ -28,7 +28,7 @@ Compile and install the mainline version from GitHub:
28 cd firejail 28 cd firejail
29 ./configure && make && sudo make install-strip 29 ./configure && make && sudo make install-strip
30 30
31On Debian/Ubuntu you will need to install git and gcc. AppArmor development 31On Debian/Ubuntu you will need to install git and gcc. AppArmor development
32libraries and pkg-config are required when using the --enable-apparmor 32libraries and pkg-config are required when using the --enable-apparmor
33./configure option: 33./configure option:
34 34
diff --git a/README.md b/README.md
index 05dd2a52f..09a3276e6 100644
--- a/README.md
+++ b/README.md
@@ -5,20 +5,24 @@
5[![CodeQL CI](https://github.com/netblue30/firejail/workflows/CodeQL/badge.svg)](https://github.com/netblue30/firejail/actions?query=workflow%3ACodeQL) 5[![CodeQL CI](https://github.com/netblue30/firejail/workflows/CodeQL/badge.svg)](https://github.com/netblue30/firejail/actions?query=workflow%3ACodeQL)
6[![Packaging status (Repology)](https://repology.org/badge/tiny-repos/firejail.svg)](https://repology.org/project/firejail/versions) 6[![Packaging status (Repology)](https://repology.org/badge/tiny-repos/firejail.svg)](https://repology.org/project/firejail/versions)
7 7
8Firejail is a SUID sandbox program that reduces the risk of security breaches by restricting 8Firejail is a SUID sandbox program that reduces the risk of security breaches
9the running environment of untrusted applications using Linux namespaces, seccomp-bpf 9by restricting the running environment of untrusted applications using Linux
10and Linux capabilities. It allows a process and all its descendants to have their own private 10namespaces, seccomp-bpf and Linux capabilities. It allows a process and all
11view of the globally shared kernel resources, such as the network stack, process table, mount table. 11its descendants to have their own private view of the globally shared kernel
12Firejail can work in a SELinux or AppArmor environment, and it is integrated with Linux Control Groups. 12resources, such as the network stack, process table, mount table. Firejail can
13 13work in a SELinux or AppArmor environment, and it is integrated with Linux
14Written in C with virtually no dependencies, the software runs on any Linux computer with a 3.x kernel 14Control Groups.
15version or newer. It can sandbox any type of processes: servers, graphical applications, and even 15
16user login sessions. The software includes sandbox profiles for a number of more common Linux programs, 16Written in C with virtually no dependencies, the software runs on any Linux
17computer with a 3.x kernel version or newer. It can sandbox any type of
18processes: servers, graphical applications, and even user login sessions. The
19software includes sandbox profiles for a number of more common Linux programs,
17such as Mozilla Firefox, Chromium, VLC, Transmission etc. 20such as Mozilla Firefox, Chromium, VLC, Transmission etc.
18 21
19The sandbox is lightweight, the overhead is low. There are no complicated configuration files to edit, 22The sandbox is lightweight, the overhead is low. There are no complicated
20no socket connections open, no daemons running in the background. All security features are 23configuration files to edit, no socket connections open, no daemons running in
21implemented directly in Linux kernel and available on any Linux computer. 24the background. All security features are implemented directly in Linux kernel
25and available on any Linux computer.
22 26
23## Videos 27## Videos
24 28
@@ -103,7 +107,7 @@ See also <https://wiki.ubuntu.com/SecurityTeam/FAQ>:
103> What software is supported by the Ubuntu Security team? 107> What software is supported by the Ubuntu Security team?
104> 108>
105> Ubuntu is currently divided into four components: main, restricted, universe 109> Ubuntu is currently divided into four components: main, restricted, universe
106> and multiverse. All binary packages in main and restricted are supported by 110> and multiverse. All binary packages in main and restricted are supported by
107> the Ubuntu Security team for the life of an Ubuntu release, while binary 111> the Ubuntu Security team for the life of an Ubuntu release, while binary
108> packages in universe and multiverse are supported by the Ubuntu community. 112> packages in universe and multiverse are supported by the Ubuntu community.
109 113
@@ -147,7 +151,7 @@ cd firejail
147./configure && make && sudo make install-strip 151./configure && make && sudo make install-strip
148``` 152```
149 153
150On Debian/Ubuntu you will need to install git and gcc. AppArmor development 154On Debian/Ubuntu you will need to install git and gcc. AppArmor development
151libraries and pkg-config are required when using the `--enable-apparmor` 155libraries and pkg-config are required when using the `--enable-apparmor`
152./configure option: 156./configure option:
153 157
@@ -171,7 +175,7 @@ firejail vlc # starting VideoLAN Client
171sudo firejail /etc/init.d/nginx start 175sudo firejail /etc/init.d/nginx start
172``` 176```
173 177
174Run `firejail --list` in a terminal to list all active sandboxes. Example: 178Run `firejail --list` in a terminal to list all active sandboxes. Example:
175 179
176```console 180```console
177$ firejail --list 181$ firejail --list
@@ -191,16 +195,16 @@ firecfg --fix-sound
191sudo firecfg 195sudo firecfg
192``` 196```
193 197
194The first command solves some shared memory/PID namespace bugs in PulseAudio software prior to version 9. 198The first command solves some shared memory/PID namespace bugs in PulseAudio
195The second command integrates Firejail into your desktop. You would need to logout and login back to apply 199software prior to version 9. The second command integrates Firejail into your
196PulseAudio changes. 200desktop. You would need to logout and login back to apply PulseAudio changes.
197 201
198Start your programs the way you are used to: desktop manager menus, file 202Start your programs the way you are used to: desktop manager menus, file
199manager, desktop launchers. 203manager, desktop launchers.
200 204
201The integration applies to any program supported by default by Firejail. 205The integration applies to any program supported by default by Firejail. There
202There are over 900 default applications in the current Firejail version, and 206are over 900 default applications in the current Firejail version, and the
203the number goes up with every new release. 207number goes up with every new release.
204 208
205We keep the application list in 209We keep the application list in
206[src/firecfg/firecfg.config](src/firecfg/firecfg.config) 210[src/firecfg/firecfg.config](src/firecfg/firecfg.config)
@@ -290,8 +294,8 @@ Discussion:
290 294
291### Profile Statistics 295### Profile Statistics
292 296
293A small tool to print profile statistics. Compile and install as usual. 297A small tool to print profile statistics. Compile and install as usual. The
294The tool is installed in the /usr/lib/firejail directory. 298tool is installed in the /usr/lib/firejail directory.
295 299
296Run it over the profiles in /etc/profiles: 300Run it over the profiles in /etc/profiles:
297 301