Skip to content

Commit

Permalink
Add Linux installation instructions
Browse files Browse the repository at this point in the history
Signed-off-by: lucperkins <lucperkins@gmail.com>
  • Loading branch information
lucperkins committed Jan 28, 2019
1 parent 993c50e commit 4e061cb
Show file tree
Hide file tree
Showing 9 changed files with 123 additions and 6 deletions.
6 changes: 3 additions & 3 deletions config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,10 @@ params:
buttonText: Falco Install Guide
buttonLink: https://github.com/falcosecurity/falco/wiki/How-to-Install-Falco-for-Linux
- title: Documentation
text: Visit our wiki where you can find information about installing Falco, configuration options, and writing custom rules.
text: In the official docs, you can find information about [installing Falco](/docs/installation), [configuration options](/docs/configuration), and writing [custom rules](/docs/rules).
icon: documentation-2.png
buttonText: Falco Wiki
buttonLink: https://github.com/falcosecurity/falco/wiki
buttonText: /docs
buttonLink: /docs
- title: Connect
text: Join our Slack team to interact with other users and developers.
icon: chat.png
Expand Down
2 changes: 2 additions & 0 deletions content/docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Documentation
description: An overview of the Falco container security system
short: Docs home
weight: 1
---

## About Falco
Expand Down
1 change: 1 addition & 0 deletions content/docs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Falco Configuration
short: Configuration
weight: 2
---

Falco's configuration file is a [YAML](http://www.yaml.org/start.html)
Expand Down
107 changes: 107 additions & 0 deletions content/docs/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
---
title: Installing Falco
short: Install
description: Get up and running on Linux
weight: 1
---

Falco can be installed on three platforms:

* [Linux](#linux)

## Linux

### Scripted install {#scripted}

To install Falco on Linux, you can download a shell script that takes care of the necessary steps:

```shell
curl -o install-falco.sh -s https://s3.amazonaws.com/download.draios.com/stable/install-falco
```

Then verify the [MD5](https://en.wikipedia.org/wiki/MD5) checksum of the script using the `md5sum` tool (or something analogous):

```shell
md5sum install-falco.sh
```

It should be `3632bde02be5aeaef522138919cfece2`.

Then run the script either as root or with sudo:

```shell
sudo bash install-falco.sh
```

### Package install {#package}

#### RHEL

1. Trust the Draios GPG key and configure the yum repository:

```shell
rpm --import https://s3.amazonaws.com/download.draios.com/DRAIOS-GPG-KEY.public
curl -s -o /etc/yum.repos.d/draios.repo https://s3.amazonaws.com/download.draios.com/stable/rpm/draios.repo
```

1. Install the EPEL repository:

> **Note** — The following command is required only if DKMS is not available in the distribution. You can verify if DKMS is available using `yum list dkms`. If necessary, install it using:

```shell
rpm -i https://mirror.us.leaseweb.net/epel/6/i386/epel-release-6-8.noarch.rpm
```

1. Install kernel headers:

> **Warning** — The following command might not work with any kernel. Make sure to customize the name of the package properly.

```shell
yum -y install kernel-devel-$(uname -r)
```

1. Install Falco:

```shell
yum -y install falco
```

To uninstall, run `yum erase falco`.

#### Debian

1. Trust the Draios GPG key, configure the apt repository, and update the package list:

```shell
curl -s https://s3.amazonaws.com/download.draios.com/DRAIOS-GPG-KEY.public | apt-key add -
curl -s -o /etc/apt/sources.list.d/draios.list https://s3.amazonaws.com/download.draios.com/stable/deb/draios.list
apt-get update
```

1. Install kernel headers:

> **Warning** — The following command might not work with any kernel. Make sure to customize the name of the package properly.

```shell
apt-get -y install linux-headers-$(uname -r)
```

1. Install Falco:

```shell
apt-get install -y falco
```

To uninstall, run `apt-get remove falco`.

## Package Management Systems

You can also install Falco using package management systems like [Puppet](#puppet) and [Ansible](#ansible).

### Puppet

A [Puppet](https://puppet.com/) module for Falco, `sysdig-falco`, is available on [Puppet Forge](https://forge.puppet.com/sysdig/falco/readme).

### Ansible

[@juju4](https://github.com/juju4/) has helpfully written an [Ansible](https://ansible.com) role for Falco, `juju4.falco`. It's available on [GitHub](https://github.com/juju4/ansible-falco/) and [Ansible Galaxy](https://galaxy.ansible.com/juju4/falco/). The latest version of Ansible Galaxy (v0.7) doesn't work with Falco 0.9, but the version on GitHub does.
1 change: 1 addition & 0 deletions content/docs/rules.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Falco Rules
short: Rules
weight: 3
---

_Call for contributions: If you come up with additional rules which you'd like to see in the core repository - PR welcome!_
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"Target":"css/style.min.ab19e1b088137f511199cece2848cbd3c3e002a60166c30b4833cdb3779e2bc5.css","MediaType":"text/css","Data":{"Integrity":"sha256-qxnhsIgTf1ERmc7OKEjL08PgAqYBZsMLSDPNs3eeK8U="}}
{"Target":"css/style.min.97ca7a3c3dca6b49510cc68b1cc0d32db93339900872406b840b9d12a61ebd1b.css","MediaType":"text/css","Data":{"Integrity":"sha256-l8p6PD3Ka0lRDMaLHMDTLbkzOZAIckBrhAudEqYevRs="}}
6 changes: 6 additions & 0 deletions themes/falco-fresh/assets/style.sass
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ $section-padding: 1rem

@import "fresh/core"

.content ol
margin-left: 1rem

li + li
margin-top: 1.25rem

.article
margin-bottom: 5rem

Expand Down
2 changes: 1 addition & 1 deletion themes/falco-fresh/layouts/partials/section2.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ <h3 class="subtitle is-5 is-muted">{{ $subtitle }}</h3>
<p>
<span class="icon-box-title">{{ .title }}</span>

<span class="icon-box-text">{{ .text }}</span>
<span class="icon-box-text">{{ .text | markdownify }}</span>
<a class="" href="{{ .buttonLink }}">
{{ .buttonText }}
</a>
Expand Down

0 comments on commit 4e061cb

Please sign in to comment.