doc: rewrite the introduction page.
This commit is contained in:
parent
36f9ae0458
commit
04dc921eb1
5 changed files with 141 additions and 38 deletions
BIN
docs/assets/avatar-icon.png
Normal file
BIN
docs/assets/avatar-icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 33 KiB |
126
docs/index.md
126
docs/index.md
|
|
@ -1,52 +1,106 @@
|
||||||
---
|
---
|
||||||
title: AppArmor.d
|
title: AppArmor.d
|
||||||
|
hide:
|
||||||
|
- toc
|
||||||
---
|
---
|
||||||
|
|
||||||
<style>.md-typeset .md-content__button { display: none; }</style>
|
<!-- Additional styles for landing page -->
|
||||||
|
<style>
|
||||||
|
/* Apply box shadow on smaller screens that don't display tabs */
|
||||||
|
@media only screen and (max-width: 1220px) {
|
||||||
|
.md-header {
|
||||||
|
box-shadow: 0 0 .2rem rgba(0, 0, 0, .1), 0 .2rem .4rem rgba(0, 0, 0, .2);
|
||||||
|
transition: color 250ms, background-color 250ms, box-shadow 250ms;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
**Full set of AppArmor profiles**
|
/* Hide the edit button */
|
||||||
|
.md-typeset .md-content__button {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
!!! danger "Help Wanted"
|
/* Get started button */
|
||||||
|
.md-typeset .md-button--primary {
|
||||||
|
color: var(--md-primary-fg-color);
|
||||||
|
background-color: var(--md-primary-bg-color);
|
||||||
|
border-color: var(--md-primary-bg-color);
|
||||||
|
}
|
||||||
|
|
||||||
This project is still in its early development. Help is very welcome; see [Development](development/index.md)
|
.md-typeset .md-button--primary:hover {
|
||||||
|
color: var(--md-primary-bg-color);
|
||||||
|
background-color: var(--md-primary-fg-color);
|
||||||
|
border-color: var(--md-primary-bg-color);
|
||||||
|
}
|
||||||
|
|
||||||
**AppArmor.d** is a set of over 1500 AppArmor profiles whose aim is to confine most Linux based applications and processes.
|
.tx-hero {
|
||||||
|
max-width: 700px;
|
||||||
|
display: flex;
|
||||||
|
padding: .4rem;
|
||||||
|
margin: 0 auto;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
### Purpose
|
.tx-hero h1 {
|
||||||
|
font-weight: 700;
|
||||||
|
font-size: 38px;
|
||||||
|
line-height: 46px;
|
||||||
|
}
|
||||||
|
|
||||||
- Confine all root processes such as all `systemd` tools, `bluetooth`, `dbus`, `polkit`, `NetworkManager`, `OpenVPN`, `GDM`, `rtkit`, `colord`
|
.tx-hero p {
|
||||||
- Confine all Desktop environments
|
color: var(--md-primary-bg-color--light);
|
||||||
- Confine all user services such as `Pipewire`, `Gvfsd`, `dbus`, `xdg`, `xwayland`
|
font-weight: 400;
|
||||||
- Confine some *"special"* user applications: web browsers, file managers, etc
|
font-size: 20px;
|
||||||
- Should not break a normal usage of the confined software
|
line-height: 32px;
|
||||||
|
}
|
||||||
|
|
||||||
See the [Concepts](concepts.md)' page for more detail on the architecture.
|
.tx-hero__image {
|
||||||
|
max-width: 1350px;
|
||||||
|
min-width: 600px;
|
||||||
|
width: 100%;
|
||||||
|
height: auto;
|
||||||
|
margin: 0 auto;
|
||||||
|
display: flex;
|
||||||
|
align-items: stretch;
|
||||||
|
}
|
||||||
|
|
||||||
### Goals
|
.tx-hero__image img {
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
min-width: 0;
|
||||||
|
}
|
||||||
|
|
||||||
- Target both desktops and servers
|
.image-wrapper img {
|
||||||
- Support for all distributions that support AppArmor:
|
width: 100%;
|
||||||
* [:material-arch: Arch Linux](install.md#archlinux)
|
height: 100%;
|
||||||
* [:material-ubuntu: Ubuntu 24.04/22.04](install.md#ubuntu)
|
min-width: 0;
|
||||||
* [:material-debian: Debian 12](install.md#debian)
|
}
|
||||||
* [:simple-suse: openSUSE Tumbleweed](install.md#opensuse)
|
|
||||||
- Support for all major desktop environments:
|
|
||||||
- [x] :material-gnome: Gnome (GDM)
|
|
||||||
- [x] :simple-kde: KDE (SDDM)
|
|
||||||
- [ ] :simple-xfce: XFCE (Lightdm) *(work in progress)*
|
|
||||||
- [Fully tested](development/tests.md)
|
|
||||||
|
|
||||||
### Demo
|
.main_logo {
|
||||||
|
fill: var(--md-primary-bg-color);
|
||||||
|
width: 30%;
|
||||||
|
}
|
||||||
|
|
||||||
You want to try this project, or you are curious about the advanced usage and security it can provide without installing it on your machine. You can try it online on my AppArmor play machine at https://play.pujol.io/
|
</style>
|
||||||
|
|
||||||
### Presentations
|
<div class="md-container tx-hero">
|
||||||
|
<div class="md-grid md-typeset">
|
||||||
Building the largest set of AppArmor profiles:
|
<div class="md-main__inner">
|
||||||
|
<div>
|
||||||
- [Linux Security Summit North America (LSS-NA 2023)](https://events.linuxfoundation.org/linux-security-summit-north-america/) *([Slide](https://lssna2023.sched.com/event/1K7bI/building-the-largest-working-set-of-apparmor-profiles-alexandre-pujol-the-collaboratory-tudublin), [Video](https://www.youtube.com/watch?v=OzyalrOzxE8))*
|
<img class="main_logo" src="assets/avatar-icon.png" alt="" draggable="false">
|
||||||
- [Ubuntu Summit 2023](https://events.canonical.com/event/31/) *([Slide](https://events.canonical.com/event/31/contributions/209/), [Video](https://www.youtube.com/watch?v=GK1J0TlxnFI))*
|
<h1>apparmor.d</h1>
|
||||||
|
<p><b>Full set of AppArmor policies</b></p>
|
||||||
### Chat
|
<p><code>apparmor.d</code> is a collection of AppArmor profiles designed to restrict the behavior of Linux applications and processes.</p>
|
||||||
|
<p>Its goal is to confine everything, targeting both desktops and servers across all distributions that support AppArmor.</p>
|
||||||
A development chat is available on https://matrix.to/#/#apparmor.d:matrix.org
|
<a href="/overview/"
|
||||||
|
title="Get Started" class="md-button md-button--primary">
|
||||||
|
Get started
|
||||||
|
<svg width="11" height="10" viewBox="0 0 11 10" fill="none" style="margin-left:2px"><path d="M1 5.16772H9.5M9.5 5.16772L6.5 1.66772M9.5 5.16772L6.5 8.66772" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></path></svg>
|
||||||
|
</a>
|
||||||
|
<a href="https://play.pujol.io/" title="Demo Server" class="md-button md-button--primary">
|
||||||
|
Demo Server
|
||||||
|
<svg height="12" width="12" viewBox="0 0 512 512"><path fill="currentColor" d="M320 0c-17.7 0-32 14.3-32 32s14.3 32 32 32l82.7 0L201.4 265.4c-12.5 12.5-12.5 32.8 0 45.3s32.8 12.5 45.3 0L448 109.3l0 82.7c0 17.7 14.3 32 32 32s32-14.3 32-32l0-160c0-17.7-14.3-32-32-32L320 0zM80 32C35.8 32 0 67.8 0 112L0 432c0 44.2 35.8 80 80 80l320 0c44.2 0 80-35.8 80-80l0-112c0-17.7-14.3-32-32-32s-32 14.3-32 32l0 112c0 8.8-7.2 16-16 16L80 448c-8.8 0-16-7.2-16-16l0-320c0-8.8 7.2-16 16-16l112 0c17.7 0 32-14.3 32-32s-14.3-32-32-32L80 32z" /></svg>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
|
||||||
|
|
@ -89,7 +89,7 @@ echo 'Optimize=compress-fast' | sudo tee -a /etc/apparmor/parser.conf
|
||||||
|
|
||||||
!!! warning
|
!!! warning
|
||||||
|
|
||||||
**Beware**: do not install a `.deb` made for Debian on Ubuntu, the packages are different.
|
**Beware**: do not install a `.deb` made for Debian on Ubuntu as the packages are different.
|
||||||
|
|
||||||
If your distribution is based on Ubuntu, you may want to manually set the target distribution by exporting `DISTRIBUTION=ubuntu`.
|
If your distribution is based on Ubuntu, you may want to manually set the target distribution by exporting `DISTRIBUTION=ubuntu`.
|
||||||
|
|
||||||
|
|
@ -125,7 +125,7 @@ echo 'Optimize=compress-fast' | sudo tee -a /etc/apparmor/parser.conf
|
||||||
|
|
||||||
!!! warning
|
!!! warning
|
||||||
|
|
||||||
**Beware**: do not install a `.deb` made for Ubuntu on Debian, the packages are different.
|
**Beware**: do not install a `.deb` made for Ubuntu on Debian as the packages are different.
|
||||||
|
|
||||||
If your distribution is based on Debian, you may want to manually set the target distribution by exporting `DISTRIBUTION=debian`.
|
If your distribution is based on Debian, you may want to manually set the target distribution by exporting `DISTRIBUTION=debian`.
|
||||||
|
|
||||||
|
|
|
||||||
48
docs/overview.md
Normal file
48
docs/overview.md
Normal file
|
|
@ -0,0 +1,48 @@
|
||||||
|
---
|
||||||
|
title: Overview
|
||||||
|
---
|
||||||
|
|
||||||
|
!!! danger "Help Wanted"
|
||||||
|
|
||||||
|
This project is still in its early development. Help is very welcome; see [Development](development/index.md)
|
||||||
|
|
||||||
|
**AppArmor.d** is a set of over 1500 AppArmor profiles whose aim is to confine most Linux based applications and processes.
|
||||||
|
|
||||||
|
### Purpose
|
||||||
|
|
||||||
|
- Confine all root processes such as all `systemd` tools, `bluetooth`, `dbus`, `polkit`, `NetworkManager`, `OpenVPN`, `GDM`, `rtkit`, `colord`
|
||||||
|
- Confine all Desktop environments
|
||||||
|
- Confine all user services such as `Pipewire`, `Gvfsd`, `dbus`, `xdg`, `xwayland`
|
||||||
|
- Confine some *"special"* user applications: web browsers, file managers, etc
|
||||||
|
- Should not break a normal usage of the confined software
|
||||||
|
|
||||||
|
See the [Concepts](concepts.md)' page for more detail on the architecture.
|
||||||
|
|
||||||
|
### Goals
|
||||||
|
|
||||||
|
- Target both desktops and servers
|
||||||
|
- Support for all distributions that support AppArmor:
|
||||||
|
* [:material-arch: Arch Linux](install.md#archlinux)
|
||||||
|
* [:material-ubuntu: Ubuntu 24.04/22.04](install.md#ubuntu)
|
||||||
|
* [:material-debian: Debian 12/13](install.md#debian)
|
||||||
|
* [:simple-suse: openSUSE Tumbleweed](install.md#opensuse)
|
||||||
|
- Support for all major desktop environments:
|
||||||
|
- [x] :material-gnome: Gnome (GDM)
|
||||||
|
- [x] :simple-kde: KDE (SDDM)
|
||||||
|
- [ ] :simple-xfce: XFCE (Lightdm) *(work in progress)*
|
||||||
|
- [Fully tested](development/tests.md)
|
||||||
|
|
||||||
|
### Demo
|
||||||
|
|
||||||
|
You want to try this project, or you are curious about the advanced usage and security it can provide without installing it on your machine. You can try it online on my AppArmor play machine at https://play.pujol.io/
|
||||||
|
|
||||||
|
### Presentations
|
||||||
|
|
||||||
|
Building the largest set of AppArmor profiles:
|
||||||
|
|
||||||
|
- [Linux Security Summit North America (LSS-NA 2023)](https://events.linuxfoundation.org/linux-security-summit-north-america/) *([Slide](https://lssna2023.sched.com/event/1K7bI/building-the-largest-working-set-of-apparmor-profiles-alexandre-pujol-the-collaboratory-tudublin), [Video](https://www.youtube.com/watch?v=OzyalrOzxE8))*
|
||||||
|
- [Ubuntu Summit 2023](https://events.canonical.com/event/31/) *([Slide](https://events.canonical.com/event/31/contributions/209/), [Video](https://www.youtube.com/watch?v=GK1J0TlxnFI))*
|
||||||
|
|
||||||
|
### Chat
|
||||||
|
|
||||||
|
A development chat is available on https://matrix.to/#/#apparmor.d:matrix.org
|
||||||
|
|
@ -138,6 +138,7 @@ nav:
|
||||||
- Home:
|
- Home:
|
||||||
- index.md
|
- index.md
|
||||||
- Getting Started:
|
- Getting Started:
|
||||||
|
- overview.md
|
||||||
- concepts.md
|
- concepts.md
|
||||||
- install.md
|
- install.md
|
||||||
- configuration.md
|
- configuration.md
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue