Skip to content

Commit

Permalink
new: initial docsy porting
Browse files Browse the repository at this point in the history
Co-Authored-By: Leonardo Di Donato <leodidonato@gmail.com>
Signed-off-by: Lorenzo Fontana <lo@linux.com>
  • Loading branch information
fntlnz and leodido committed Jan 18, 2021
1 parent 3a840f8 commit 54a4af7
Show file tree
Hide file tree
Showing 39 changed files with 360 additions and 79 deletions.
6 changes: 3 additions & 3 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[submodule "public"]
path = public
url = https://github.com/falcosecurity/falcosecurity.github.io
[submodule "themes/docsy"]
path = themes/docsy
url = https://github.com/google/docsy
115 changes: 115 additions & 0 deletions assets/icons/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
116 changes: 116 additions & 0 deletions assets/scss/_nav.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
.td-navbar-cover {
background: $primary;

@include media-breakpoint-up(md) {
background: transparent !important;

.nav-link {
text-shadow: 1px 1px 2px $dark;
}

.brand-name {
display: none;}

}

&.navbar-bg-onscroll .nav-link {
text-shadow: none;
}
}

.navbar-bg-onscroll {
background: $primary !important;
opacity: inherit;
}

.td-navbar {
background: $primary;
min-height: 4rem;
margin: 0;
z-index: 32;

.brand-name {
display: none;}

@include media-breakpoint-up(md) {
position: fixed;
top: 0;
width: 100%;
}

.navbar-brand {
text-transform: none;
text-align: middle;
margin: 0;
padding: 0;

.nav-link {
display: inline-block;
margin-right: -30px;
}

.navbar-logo {
svg {
display: inline-block;
position: absolute;
top: 0;
left: 5px;
z-index: 33;
padding: 10px;
height: 65px;
width: 200px;

@include media-breakpoint-down(md) {
left: 16px;
width: 80px;
height: auto;
padding: 6px;
}
}
}
}

.nav-link {
text-transform: none;
font-weight: $font-weight-bold;
}

.td-search-input {
border: none;

@include placeholder {
color: $navbar-dark-color;
}
}

.dropdown {
min-width: 100px;
}

@include media-breakpoint-down(md) {
padding-right: .5rem;
padding-left: .75rem;
align-items: flex-end;

.td-navbar-nav-scroll {
max-width: calc(100% + .75rem - 96px - 1.5rem);
height: 2.5rem;
margin-top: .25rem;
overflow: hidden;
font-size: .875rem;

.nav-link {
padding-right: .25rem;
padding-left: 0;
}

.navbar-nav {
margin-top: 0 !important;
padding-bottom: 2rem;
overflow-x: auto;
white-space: nowrap;
-webkit-overflow-scrolling: touch;
}
}
}
}
2 changes: 2 additions & 0 deletions assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
$primary: #00aec7;
$secondary: #53565a;
20 changes: 19 additions & 1 deletion config.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
baseURL: /
languageCode: en-us
theme: falco-fresh
theme: docsy
disableKinds: ["taxonomy", "taxonomyTerm"]
pygmentsCodefences: true
pygmentsStyle: monokai
Expand Down Expand Up @@ -482,8 +482,26 @@ languages:

params:
version: v0.26.2

githubRepository : falcosecurity/falco
sha256sum: 21e8053c37e32f95d91c9393d961af1c63b5839d795c8cac314d05daadea9779
offlineSearch: true
ui:
navbar_logo: true
sidebar_search_disable: false
sidebar_menu_compact: false
breadcrumb_disable: false
feedback:
enable: true
'yes': >-
Glad to hear it! Please <a
href="https://github.com/falcosecurity/falco-website/issues/new">tell us how we
can improve</a>.
'no': >-
Sorry to hear that. Please <a
href="https://github.com/falcosecurity/falco-website/issues/new">tell us how we
can improve</a>.
primaryFont:
name: "Karla"
sizes: [400 700]
Expand Down
5 changes: 2 additions & 3 deletions content/en/docs/configuration/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,12 @@ weight: 3
notoc: true
---

{{< info >}}

{{% pageinfo color="primary" %}}
This is for the Falco daemon configuration options.

Please visit [rules](../rules) or [alerts](../alerts) for those options.

{{< /info >}}
{{% /pageinfo %}}


Falco's configuration file is a [YAML](http://www.yaml.org/start.html) file containing a collection of `key: value` or `key: [value list]` pairs.
Expand Down
7 changes: 3 additions & 4 deletions content/en/docs/event-sources/sample-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,10 @@ The full command line documentation is [here](https://github.com/falcosecurity/e

### System Call Activity

{{< info >}}

{{% pageinfo color="primary" %}}
**Warning** — We strongly recommend that you run the program within Docker (see below), since some commands might alter your system. For example, some actions modify files and directories below `/bin`, `/etc`, `/dev`, etc.

{{< /info >}}
{{% /pageinfo %}}

The `syscall` collection performs a variety of suspect actions that are detected by the [default Falco ruleset](https://github.com/falcosecurity/falco/blob/master/rules/falco_rules.yaml).

Expand Down Expand Up @@ -69,4 +68,4 @@ kubectl apply -f deployment/role-rolebinding-serviceaccount.yaml \

The above command applies to the default namespace. Use the `--namespace` option to deploy in a different namespace. Events will be generated in the same namespace.

You can also find more examples in the repository [documentation](https://github.com/falcosecurity/event-generator#with-kubernetes).
You can also find more examples in the repository [documentation](https://github.com/falcosecurity/event-generator#with-kubernetes).
7 changes: 3 additions & 4 deletions content/en/docs/getting-started/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,15 @@ The list of all available artifacts can be found [here](https://bintray.com/falc

### Download container images {#images}

{{< info >}}

{{% pageinfo color="primary" %}}
Falco depends on having a driver installed on the host system to get information about the running system calls.

The preferred installation method is to install the driver using the native artifacts defined above or
temporarily run the `falcosecurity/falco-driver-loader` image as privileged, then using the `falcosecurity/falco-no-driver`.

For more details, see the [Run within Docker section](/docs/getting-started/running#docker).

{{< /info >}}
{{% /pageinfo %}}

|tag | pull command | description |
|----|----------|-----------------|
Expand All @@ -55,4 +54,4 @@ The list of all available images can be found [here](https://github.com/falcosec
[3]: https://dl.bintray.com/falcosecurity/deb-dev/stable
[4]: https://dl.bintray.com/falcosecurity/deb/stable
[5]: https://dl.bintray.com/falcosecurity/bin-dev/x86_64
[6]: https://dl.bintray.com/falcosecurity/bin/x86_64
[6]: https://dl.bintray.com/falcosecurity/bin/x86_64
4 changes: 2 additions & 2 deletions content/en/docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ weight: 3

Falco is a Linux security tool that uses system calls to secure and monitor a system.

{{< info >}}
{{% pageinfo color="primary" %}}
Falco can be used for Kubernetes runtime security.
The most secure way to run Falco is to install Falco directly on the host system so that Falco is isolated from Kubernetes in the case of compromise.
Then the Falco alerts can be consumed via read-only agents running in Kubernetes.

Falco can also be ran directly in Kubernetes if isolation is not a concern.
If you would like to run Falco directly in Kubernetes with a tool like Kind, Minikube, or Helm please see the [third party integrations](../third-party)
{{< /info >}}
{{% /pageinfo %}}


If Falco is installed using the package manager artifacts below, you will have the following in place:
Expand Down
Loading

0 comments on commit 54a4af7

Please sign in to comment.