aboutsummaryrefslogtreecommitdiffstats
path: root/docs/getting_started.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/getting_started.rst')
-rw-r--r--docs/getting_started.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
new file mode 100644
index 000000000..abb9589d0
--- /dev/null
+++ b/docs/getting_started.rst
@@ -0,0 +1,35 @@
1.. _getting_started:
2
3Getting Started with Firejail
4================================================================================
5
6A brief overview of Firejail, how to install it, and some common uses.
7
8What is Firejail?
9--------------------------------------------------------------------------------
10Firejail is a sandbox program for Linux that aims to do three things:
11
121. Reduce the risk of security breaches by isolating and `sandboxing`_ programs.
132. Integrate well with other existing technology like SELinux or AppArmor.
143. Be easy to use, with very little consumption of computer resources.
15
16Traditional Linux sandboxes have offered fine-grained control for users, but
17often at the cost of being difficult to configure and use. In contrast, there is
18no *difficult* in Firejail, at least no *SELinux-difficult*. For us, the
19user always comes first. We want Firejail to be simple to use, powerful but not
20complicated.
21
22
23Quick install tips
24--------------------------------------------------------------------------------
25As with many other Linux programs, it's best to check if Firejail is present in
26your distribution's repositories and install from there, unless you need a
27specific version. Many distributions, such as Arch, Debian, Gentoo, and Ubuntu,
28provide Firejail.
29
30We also provide pre-built packages of the `latest release`_ and
31`latest long-term support (LTS) release`_ on our Sourceforge download page.
32
33.. _sandboxing: https://en.wikipedia.org/wiki/Sandbox_(computer_security)
34.. _latest release: https://sourceforge.net/projects/firejail/files/firejail/
35.. _latest long-term support (LTS) release: https://sourceforge.net/projects/firejail/files/LTS/