aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar Kelvin M. Klann <kmk3.code@protonmail.com>2023-03-23 16:47:40 -0300
committerLibravatar Kelvin M. Klann <kmk3.code@protonmail.com>2023-03-26 13:50:54 -0300
commit79c52d8e971c32d0a19c1bf65d5b8183f852cadc (patch)
treec13699456c0a41d68407875d88a9b5a012d4f7e3 /README.md
parentREADME.md: improve badges/links (diff)
downloadfirejail-79c52d8e971c32d0a19c1bf65d5b8183f852cadc.tar.gz
firejail-79c52d8e971c32d0a19c1bf65d5b8183f852cadc.tar.zst
firejail-79c52d8e971c32d0a19c1bf65d5b8183f852cadc.zip
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
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 27 insertions, 10 deletions
diff --git a/README.md b/README.md
index d03f4776a..a157651c3 100644
--- a/README.md
+++ b/README.md
@@ -189,23 +189,35 @@ PulseAudio changes.
189Start your programs the way you are used to: desktop manager menus, file manager, desktop launchers. 189Start your programs the way you are used to: desktop manager menus, file manager, desktop launchers.
190The integration applies to any program supported by default by Firejail. There are about 250 default applications 190The integration applies to any program supported by default by Firejail. There are about 250 default applications
191in current Firejail version, and the number goes up with every new release. 191in current Firejail version, and the number goes up with every new release.
192We keep the application list in [/etc/firejail/firecfg.config](https://github.com/netblue30/firejail/blob/master/src/firecfg/firecfg.config) file. 192
193We keep the application list in
194[src/firecfg/firecfg.config](src/firecfg/firecfg.config)
195(/etc/firejail/firecfg.config when installed).
193 196
194## Security profiles 197## Security profiles
195 198
196Most Firejail command line options can be passed to the sandbox using profile files. 199Most Firejail command line options can be passed to the sandbox using profile
197You can find the profiles for all supported applications in [/etc/firejail](https://github.com/netblue30/firejail/tree/master/etc) directory. 200files.
201
202You can find the profiles for all supported applications in [etc/](etc/)
203(/etc/firejail/ when installed).
204
205We also keep a list of profile fixes for previous released versions in
206[etc-fixes/](etc-fixes/).
198 207
199If you keep additional Firejail security profiles in a public repository, please give us a link: 208If you keep additional Firejail security profiles in a public repository,
209please give us a link:
200 210
201* <https://github.com/chiraag-nataraj/firejail-profiles> 211* <https://github.com/chiraag-nataraj/firejail-profiles>
202* <https://github.com/triceratops1/fe> 212* <https://github.com/triceratops1/fe>
203 213
204Use this issue to request new profiles: [#1139](https://github.com/netblue30/firejail/issues/1139) 214Use this issue to request new profiles:
205 215
206You can also use this tool to get a list of syscalls needed by a program: [contrib/syscalls.sh](contrib/syscalls.sh). 216* [Profile requests](https://github.com/netblue30/firejail/issues/1139)
207 217
208We also keep a list of profile fixes for previous released versions in [etc-fixes](https://github.com/netblue30/firejail/tree/master/etc-fixes) directory. 218You can also use this tool to get a list of syscalls needed by a program:
219
220* [contrib/syscalls.sh](contrib/syscalls.sh)
209 221
210## Latest released version: 0.9.72 222## Latest released version: 0.9.72
211 223
@@ -257,13 +269,18 @@ We also keep a list of profile fixes for previous released versions in [etc-fixe
257 $ strace /usr/bin/transmission-qt 2>&1 | grep open | grep etc 269 $ strace /usr/bin/transmission-qt 2>&1 | grep open | grep etc
258``` 270```
259 271
260We keep the list of groups in [src/include/etc_groups.h](https://github.com/netblue30/firejail/blob/master/src/include/etc_groups.h) 272We keep the list of groups in
273[src/include/etc_groups.h](src/include/etc_groups.h).
274
275Discussion:
261 276
262Discussion: <https://github.com/netblue30/firejail/discussions/5610> 277* [private-etc rework](https://github.com/netblue30/firejail/discussions/5610)
263 278
264### Profile Statistics 279### Profile Statistics
265 280
266A small tool to print profile statistics. Compile and install as usual. The tool is installed in /usr/lib/firejail directory. 281A small tool to print profile statistics. Compile and install as usual.
282The tool is installed in the /usr/lib/firejail directory.
283
267Run it over the profiles in /etc/profiles: 284Run it over the profiles in /etc/profiles:
268 285
269```console 286```console