Skip to content

Commit

Permalink
docs: line-wrap some long lines
Browse files Browse the repository at this point in the history
  • Loading branch information
kmk3 committed Mar 26, 2023
1 parent 82eecd4 commit 331158d
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 26 deletions.
9 changes: 6 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ _Describe the bug_

_Steps to reproduce the behavior_

1. Run in bash `LC_ALL=C firejail PROGRAM` (`LC_ALL=C` to get a consistent output in English that can be understood by everybody)
1. Run in bash `LC_ALL=C firejail PROGRAM` (`LC_ALL=C` to get a consistent
output in English that can be understood by everybody)
2. Click on '....'
3. Scroll down to '....'
4. See error `ERROR`
Expand All @@ -37,7 +38,8 @@ _What actually happened_

### Behavior without a profile

_What changed calling `LC_ALL=C firejail --noprofile /path/to/program` in a terminal?_
_What changed calling `LC_ALL=C firejail --noprofile /path/to/program` in a
terminal?_

### Additional context

Expand All @@ -47,7 +49,8 @@ _Any other detail that may help to understand/debug the problem_

- Linux distribution and version (e.g. "Ubuntu 20.04" or "Arch Linux")
- Firejail version (`firejail --version`).
- If you use a development version of firejail, also the commit from which it was compiled (`git rev-parse HEAD`).
- If you use a development version of firejail, also the commit from which it
was compiled (`git rev-parse HEAD`).

### Checklist

Expand Down
6 changes: 4 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
If your PR isn't about profiles or you have no idea how to do one of these, skip the following and go ahead with this PR.
If your PR isn't about profiles or you have no idea how to do one of these,
skip the following and go ahead with this PR.

If you submit a PR for new profiles or changing profiles, please do the following:
If you submit a PR for new profiles or changing profiles, please do the
following:

- The ordering of options follow the rules described in
[etc/templates/profile.template](../blob/master/etc/templates/profile.template)
Expand Down
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Welcome to firejail, and thank you for your interest in contributing!

## Opening an issue

We welcome issues, whether to ask a question, provide information, request a new profile or
feature, or to report a suspected bug or problem.
We welcome issues, whether to ask a question, provide information, request a
new profile or feature, or to report a suspected bug or problem.

If you want to request a program profile that we don't already have, please add
a comment in our dedicated issue:
Expand Down Expand Up @@ -62,4 +62,5 @@ If you add a new command, here's the checklist:

## Editing the wiki

You are highly encouraged to add your own tips and tricks to the [wiki](https://github.com/netblue30/firejail/wiki).
You are highly encouraged to add your own tips and tricks to the
[wiki](https://github.com/netblue30/firejail/wiki).
27 changes: 17 additions & 10 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ Committers:
- rusty-snake (https://github.com/rusty-snake)
- smitsohu (https://github.com/smitsohu)
- SkewedZeppelin (https://github.com/SkewedZeppelin)
- startx2017 (https://github.com/startx2017) - LTS and *bugfixes branches maintainer)
- startx2017 (https://github.com/startx2017) - LTS and *bugfixes branches
maintainer)
- Topi Miettinen (https://github.com/topimiettinen)
- veloute (https://github.com/veloute)
- Vincent43 (https://github.com/Vincent43)
Expand Down Expand Up @@ -317,7 +318,8 @@ curiosityseeker (https://github.com/curiosityseeker - new)
- updated keypassxc profile
- added syscalls.sh, which determine the necessary syscalls for a program
- fixed conky profile
- thunderbird.profile: harden and enable the rules necessary to make Firefox open links
- thunderbird.profile: harden and enable the rules necessary to make
Firefox open links
da2x (https://github.com/da2x)
- matched RPM license tag
Daan Bakker (https://github.com/dbakker)
Expand Down Expand Up @@ -362,7 +364,8 @@ Disconnect3d (https://github.com/disconnect3d)
dm9pZCAq (https://github.com/dm9pZCAq)
- fix for compilation under musl
dmfreemon (https://github.com/dmfreemon)
- add sandbox name or name of private directory to the window title when xpra is used
- add sandbox name or name of private directory to the window title
when xpra is used
- handle malloc() failures; use gnu_basename() instead of basenaem()
Dmitriy Chestnykh (https://github.com/chestnykh)
- add ability to disable user profiles at compile time
Expand Down Expand Up @@ -1034,7 +1037,8 @@ soredake (https://github.com/soredake)
- add localtime to private-etc to make qtox show correct time
- fixes for the keepassxc 2.2.5 version
SkewedZeppelin (https://github.com/SkewedZeppelin)
- added Bless, Gnome 2048, Gnome Calculator, Gnome Contacts, JD-GUI, Lollypop, MultiMC5 profiles
- added Bless, Gnome 2048, Gnome Calculator, Gnome Contacts, JD-GUI,
Lollypop, MultiMC5 profiles
- added PDFSam, Pithos, and Xonotic profiles
- disabled Go, Rust, and OpenSSL in disable-devel.conf
- added dino profile
Expand All @@ -1052,7 +1056,8 @@ SkewedZeppelin (https://github.com/SkewedZeppelin)
- added IntelliJ IDEA and Android Studio profiles
- added arm profile
- lots of profile improvements/tightening
- added apktool, baobab, dex2jar, gitg, hashcat, obs, picard, remmina, sdat2img,
- added apktool, baobab, dex2jar, gitg, hashcat, obs, picard, remmina,
sdat2img,
soundconverter, sqlitebrowser, and truecraft profiles
- added gnome-twitch profile
- Unified all 341 profiles
Expand Down Expand Up @@ -1089,10 +1094,12 @@ SYN-cook (https://github.com/SYN-cook)
- gnome-calculator changes
startx2017 (https://github.com/startx2017)
- syscall list update
- updated default seccomp filters - added bpf, clock_settime, personality, process_vm_writev, query_module,
settimeofday, stime, umount, userfaultfd, ustat, vm86, and vm86old
- updated default seccomp filters - added bpf, clock_settime,
personality, process_vm_writev, query_module, settimeofday, stime,
umount, userfaultfd, ustat, vm86, and vm86old
- enable/disable join support in /etc/firejail/firejail.config
- firecfg fix: create ~/.local/share/applications directory if it doesn't exist
- firecfg fix: create ~/.local/share/applications directory if it
doesn't exist
- firejail.config cleanup
- --quiet fixes
- bugfixes branches maintainer
Expand Down Expand Up @@ -1254,8 +1261,8 @@ Zack Weinberg (https://github.com/zackw)
- wait_for_other function rewrite
- Xvfb X11 server support
- Xvfb and Xephyr profiles, modified Xpra profile
- support for sandboxing Xpra, Xvfb and Xephyr in independent sandboxes when started
with firejail --x11
- 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
Expand Down
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,14 @@ See [SECURITY.md](SECURITY.md).

### Debian

Debian stable (bullseye): We recommend to use the [backports](https://packages.debian.org/bullseye-backports/firejail) package.
Debian stable (bullseye): We recommend to use the
[backports](https://packages.debian.org/bullseye-backports/firejail) package.

### Ubuntu

For Ubuntu 18.04+ and derivatives (such as Linux Mint), users are **strongly advised** to use the [PPA](https://launchpad.net/~deki/+archive/ubuntu/firejail).
For Ubuntu 18.04+ and derivatives (such as Linux Mint), users are **strongly
advised** to use the
[PPA](https://launchpad.net/~deki/+archive/ubuntu/firejail).

How to add and install from the PPA:

Expand All @@ -88,10 +91,12 @@ sudo apt-get update
sudo apt-get install firejail firejail-profiles
```

Reason: The firejail package for Ubuntu 20.04 has been left vulnerable to CVE-2021-26910 for months after a patch for it was posted on Launchpad:
Reason: The firejail package for Ubuntu 20.04 has been left vulnerable to
CVE-2021-26910 for months after a patch for it was posted on Launchpad:

* [CVE-2021-26910](https://github.com/advisories/GHSA-2q4h-h5jp-942w)
* [firejail version in Ubuntu 20.04 LTS is vulnerable to CVE-2021-26910](https://bugs.launchpad.net/ubuntu/+source/firejail/+bug/1916767)
* [firejail version in Ubuntu 20.04 LTS is vulnerable to
CVE-2021-26910](https://bugs.launchpad.net/ubuntu/+source/firejail/+bug/1916767)

See also <https://wiki.ubuntu.com/SecurityTeam/FAQ>:

Expand All @@ -102,12 +107,15 @@ See also <https://wiki.ubuntu.com/SecurityTeam/FAQ>:
> the Ubuntu Security team for the life of an Ubuntu release, while binary
> packages in universe and multiverse are supported by the Ubuntu community.
Additionally, the PPA version is likely to be more recent and to contain more profile fixes.
Additionally, the PPA version is likely to be more recent and to contain more
profile fixes.

See the following discussions for details:

* [Should I keep using the version of firejail available in my distro repos?](https://github.com/netblue30/firejail/discussions/4666)
* [How to install the latest version on Ubuntu and derivatives](https://github.com/netblue30/firejail/discussions/4663)
* [Should I keep using the version of firejail available in my distro
repos?](https://github.com/netblue30/firejail/discussions/4666)
* [How to install the latest version on Ubuntu and
derivatives](https://github.com/netblue30/firejail/discussions/4663)

### Other

Expand Down Expand Up @@ -149,7 +157,8 @@ sudo apt-get install git build-essential libapparmor-dev pkg-config gawk

For `--selinux` option, add libselinux1-dev (libselinux-devel for Fedora).

Detailed information on using firejail from git is available on the [wiki](https://github.com/netblue30/firejail/wiki/Using-firejail-from-git).
Detailed information on using firejail from git is available on the
[wiki](https://github.com/netblue30/firejail/wiki/Using-firejail-from-git).

## Running the sandbox

Expand Down

0 comments on commit 331158d

Please sign in to comment.