Commit graph

709 commits

Author SHA1 Message Date
Ted Robertson
d763fb73ca
docs: clarify intro and build section in README (#6524)
Make the introduction friendlier for non-kernel geeks and clarify the
build section.

Relates to #4049.
2024-11-04 18:58:24 +00:00
Ted Robertson
cf02e8dd4f
docs: fix typos of --enable-selinux configure option (#6526) 2024-10-31 18:48:37 +00:00
Kelvin M. Klann
6ba0e38241 README.md: fix Landlock support list
Fix formatting and wrong/outdated information.

This amends commit 6d0559de7 ("landlock: update README.md, small fix in
man firejal; update profile stats in README.md", 2023-12-04).

Relates to #6078.
2023-12-05 11:19:04 -03:00
glitsj16
666063f575 docs: fix typo of --nonewprivs in Landlock section
Originally from PR #5359.

Relates to #6078.
2023-12-05 11:00:06 -03:00
netblue30
6d0559de7d landlock: update README.md, small fix in man firejal; update profile stats in README.md 2023-12-04 10:20:51 -05:00
Kelvin M. Klann
5639359664 docs: add missing CI badges to README.md 2023-08-22 04:58:21 -03:00
Kelvin M. Klann
1c9af28611 ci: move main code checks into new check-c.yml
Move scan-build, cppcheck and CodeQL (cpp).

This is similar to build-extra.yml, but for jobs that check for issues
in the code rather than checking for build failures.

Note: As this deletes codeql-analysis.yml, its configuration also has to
be deleted in the GitHub web UI to prevent it from warning about the
file being missing:

* Security -> Code scanning -> Tool status -> (Setup Types) CodeQL ->
  (Configurations) language:python -> Delete configuration

Misc: The above was clarified by @topimiettinen[1].

[1] https://github.com/netblue30/firejail/pull/5960#issuecomment-1685262643
2023-08-22 04:58:21 -03:00
Kelvin M. Klann
29f7a94610 ci: remove "CI" from workflow names
All of the current workflows are used for CI.
2023-08-20 12:31:14 -03:00
Kelvin M. Klann
3f52c0e26e docs: add uninstall instructions to README.md
Clarify how to remove the symlinks created by firecfg.

Reported by @MikeNavy in #5098.
2023-05-02 09:31:22 -03:00
Kelvin M. Klann
a516247a1c 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.
2023-03-26 13:52:11 -03:00
Kelvin M. Klann
331158da03 docs: line-wrap some long lines 2023-03-26 13:51:25 -03:00
Kelvin M. Klann
82eecd4c78 docs: fix misc texts/formatting 2023-03-26 13:51:25 -03:00
Kelvin M. Klann
79c52d8e97 docs: clarify and improve links and items
Changes:

* Add titles to referenced issues/discussions
* Use relative links for paths
* Separate repo paths from installed paths
* Turn some links and items into lists to make them stand out
2023-03-26 13:50:54 -03:00
Kelvin M. Klann
6db6af6a94 README.md: improve badges/links 2023-03-26 12:48:50 -03:00
Kelvin M. Klann
e4aa6b1d6c README.md: sort badges
Put lint after builds.
2023-03-26 12:48:50 -03:00
Kelvin M. Klann
6eca8eb99a README.md: add full repology list inside details tag
And clarify the distribution installation steps.
2023-03-26 12:48:36 -03:00
Kelvin M. Klann
a91dd6a052 README.md: update SourceForge link to GitHub Releases 2023-03-26 12:46:26 -03:00
Kelvin M. Klann
0bfa2a2745 README.md: add link to CVE-2021-26910
See https://github.com/advisories/GHSA-2q4h-h5jp-942w
2023-03-26 12:46:26 -03:00
Kelvin M. Klann
fca903b245 README.md: add headings for videos and links 2023-03-26 12:46:26 -03:00
Kelvin M. Klann
415aad5204 README.md: format html to improve readability 2023-03-26 12:46:26 -03:00
Kelvin M. Klann
0d42df0a75 README.md: turn scattered items into a list 2023-03-26 12:46:26 -03:00
Kelvin M. Klann
f80ba2fba7 README.md: turn bare URLs into links
For increased portability.

Fixes[1]:

* MD034 Bare URL used

[1] https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md
2023-03-26 12:46:26 -03:00
Kelvin M. Klann
f72d738e61 docs: improve code blocks
Changes:

* Use the usual 3 instead of 5 backticks for code fences
* To improve syntax highlighting, remove the leading dollar signs for
  command lines without output and set the language used
2023-03-26 12:46:20 -03:00
Kelvin M. Klann
1f0d47572f docs: deduplicate info from SECURITY.md 2023-03-26 03:54:40 -03:00
Kelvin M. Klann
707c7917e5 docs: fix line breaks around elements in markdown
Ensure consistent line breaks around headings, lists and code blocks.

To make them more readable and also more portable (which could help when
previewing/converting files locally).

From the CommonMark Spec (version 0.30, published on 2021-06-19)[1]:

> 1.2 Why is a spec needed?

[...]

> 2. Is a blank line needed before a block quote or heading?  Most
>    implementations do not require the blank line.  However, this can
>    lead to unexpected results in hard-wrapped text, and also to
>    ambiguities in parsing (note that some implementations put the
>    heading inside the blockquote, while others do not).  (John Gruber
>    has also spoken in favor of requiring the blank lines.)[2]
>
> 3. Is a blank line needed before an indented code block?
>    (`Markdown.pl` requires it, but this is not mentioned in the
>    documentation, and some implementations do not require it.)

Fixes[3]:

* MD022 Headers should be surrounded by blank lines
* MD031 Fenced code blocks should be surrounded by blank lines
* MD032 Lists should be surrounded by blank lines

Environment: ruby-mdl 0.12.0-1 on Artix Linux.

[1] https://spec.commonmark.org/0.30/#why-is-a-spec-needed-
[2] http://article.gmane.org/gmane.text.markdown.general/2146
[3] https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md
2023-03-24 11:06:31 -03:00
Kelvin M. Klann
e0311253c2 README.md: remove unicode and non-printing chars
Changes:

* Replace Unicode apostrophe with an ASCII one
* Strip non-printing characters from the output of --private-etc

Commands used to get a clean manpage output:

    man firejail | less

Environment: mandoc 1.14.6-1 on Artix Linux
2023-03-24 10:54:59 -03:00
Kelvin M. Klann
f70577b490 README.md: fix output of profstats 2023-03-24 03:04:35 -03:00
Kelvin M. Klann
3812c139a6 Fix EOL at EOF
Commands used to search and replace:

    $ git grep -Ilz '.' | xargs -0 -I '{}' sh -c \
      "printf '%s\n' \"\$(cat '{}')\" >'{}'"

The above commands ensure that there is exaclty 1 line terminator at EOF
(rather than 0 or more than 1) on all non-empty text files.

This fixes all of the "new blank line at EOF" errors raised by git:

    $ git diff --check 4b825dc642cb6eb9a060e54bf8d69288fbee4904..HEAD |
      grep '^[^+]' | cut -f 3 -d : | LC_ALL=C sort | uniq -c
         21  new blank line at EOF.
         72  space before tab in indent.
          4  trailing whitespace.
2023-02-19 20:57:12 -03:00
netblue30
9d68139d7b merges 2023-02-06 10:17:58 -05:00
netblue30
5d5f554ab1 private-etc: moved group names to @group syntax; GUI group renamed as @x11 group; added nvidia and X11 directories to @x11 group. 2023-01-30 08:14:13 -05:00
netblue30
be88622c89 private-etc: fix man page 2023-01-25 12:20:13 -05:00
netblue30
9774ab8a35 private-etc rework: new man page 2023-01-25 11:56:08 -05:00
netblue30
70974170c7
Merge pull request #5589 from nya1/fix/apparmor-invalid-command-line-option
docs: remove apparmor options in --help when building without apparmor support
2023-01-18 10:29:57 -05:00
netblue30
347c0e3ada update README.md 2023-01-18 10:26:51 -05:00
nya1
ed16bdfdfd chore: update readme with flag to enable apparmor on ./configure 2023-01-14 16:04:43 +01:00
glitsj16
096ced5b24
README.md: add linuxqq/qq to 'New profiles' section 2023-01-03 07:59:36 +00:00
netblue30
e80fae7472 restrict-namespaces stats 2022-12-26 09:49:42 -05:00
glitsj16
73a6fced28
New profile: ssmtp (#5544)
* disable-programs.inc: add ssmtp support

* Create ssmtp.profile

* ssmtp: support Debian/Ubuntu

* README.md: add ssmtp to 'New profiles' section

* disable-common.inc: move ssmtp support to keep CI happy

* ssmtp: improve dead.letter comment

Suggested in [review](https://github.com/netblue30/firejail/pull/5544#pullrequestreview-1225322546).
2022-12-21 23:38:25 +00:00
netblue30
65c92b464e fixes 2022-12-14 14:32:22 -05:00
glitsj16
0e133dc034
New profile: tesseract (#5516)
* Add firecfg support for tesseract

* Add tesseract to 'New profiles' section in README.md

* Create tesseract.profile

* tesseract: fix private-etc

* tesseract: fix XDG black/whitelisting

* tesseract: use 'seccomp socket' instead of 'protocol unix'

As kindly suggested by @rusty-snake.

* tesseract: add 'restrict-namespaces'

As kindly suggested by @rusty-snake.

* tesseract: use full seccomp filtering

The tesseract application works fine without 'protocol' or 'seccomp socket'.
2022-12-09 12:36:28 +00:00
glitsj16
98e8f28164
Add support for cinelerra-gg (#5467)
* Create cinelerra-gg

* add cinelerra-gg to `New profiles` section

* Add cinelerra-gg to firecfg.config
2022-11-13 00:05:03 +00:00
netblue30
729b1251cd --icmptrace 2022-10-24 08:35:01 -04:00
netblue30
a0985a1353 dnstrace and snitrace 2022-10-23 07:38:29 -04:00
Kelvin M. Klann
dfc5593129 README.md: remove items duplicated from RELNOTES
Added on commit 6d740d7dc ("RELNOTES and README.md - existing
functionality modified for the next version", 2022-08-29).

The duplication makes it harder to maintain the RELNOTES, especially
because the contents are prone to diverge between each file.

For example, even though the commit in question (6d740d7dc) added the
same items to both files, the additions to RELNOTES had two typos, while
the additions to README.md had one typo.

The typos in RELNOTES were fixed by commit c5e8d5d1f ("typo fixes for
RELNOTES", 2022-08-29), and the typo in README.md was fixed by commit
2ac8a93fd ("typo fix for README.md", 2022-08-29), both from PR #5349.
2022-09-19 15:11:43 -03:00
Kelvin M. Klann
60db9f7851
Merge pull request #5347 from kmk3/revert-landlock
Revert "Add Landlock support to Firejail"
2022-09-06 11:20:55 +00:00
netblue30
d900d53196 README/README.md
Committer note: This is the same as commit 796fa0963
("README/README.md", 2022-08-30) and commit 0594c5d3d ("typos",
2022-08-30) but without the Landlock-related changes.
2022-09-05 01:07:41 -03:00
Kelvin M. Klann
2a79f3a268 Revert "README/README.md"
This reverts commit 796fa09636.

Part of reverting commits with Landlock-related changes.
2022-09-05 01:07:41 -03:00
Kelvin M. Klann
67348ac9c2 Revert "typos"
This reverts commit 0594c5d3d0.

Part of reverting commits with Landlock-related changes.
2022-09-05 01:07:41 -03:00
Kelvin M. Klann
26c74796f3 Revert "landlock: check for landlock support in glibc"
This reverts commit c5a052ffa4.

Part of reverting commits with Landlock-related changes.
2022-09-05 01:07:39 -03:00
glitsj16
a8cf8974a7
Add IRC channel info to README.md 2022-09-05 02:46:34 +00:00