Skip to content

Make getting started page more friendly #2045

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 20, 2025
Merged

Make getting started page more friendly #2045

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8404418
Make getting started page more friendly
esmerel Aug 20, 2025
7c33a2b
Update installation/getting-started-with-fluent-bit.md
esmerel Aug 20, 2025
999829d
Apply suggestions from code review
esmerel Aug 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 24 additions & 14 deletions installation/getting-started-with-fluent-bit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,32 @@

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=e9732f9c-44a4-46d3-ab87-86138455c698" />

## Container deployment
The Fluent Bit telemetry agent is available for Linux, macOS, Windows, and BSD family operating systems.

If you are interested in learning about Fluent Bit you can try out the [sandbox environment](../about/sandbox-and-lab-resources.md).

## Requirements

All Fluent Bit installations must meet certain [requirements](./requirements.md).

## Supported platforms and packages

Fluent Bit software is available for a variety of platforms and can be installed
using several methods.

You can [direct download and compile the source code](../installation/sources/README.md).

You can also select a package follow the specific instructions for it using the following links:

### Container deployment

| Deployment Type | Instructions |
| ----------------- | -------------------------------------------------- |
| Kubernetes | [Deploy on Kubernetes](kubernetes.md#installation) |
| Docker | [Deploy with Docker](docker.md) |
| Containers on AWS | [Deploy on Containers on AWS](aws-container.md) |

## Install on Linux (packages)
### Install on Linux (packages)

| Operating System | Installation instructions |
| ---------------------- | ------------------------- |
Expand All @@ -25,35 +42,28 @@
| Yocto / Embedded Linux | [Yocto / Embedded Linux](yocto-embedded-linux.md#fluent-bit-and-other-architectures) |
| Buildroot / Embedded Linux | [Buildroot / Embedded Linux](buildroot-embedded-linux.md) |

## Install on Windows (packages)
### Install on Windows (packages)

| Operating System | Installation instructions |
| ------------------- | ------------------------- |
| Windows Server 2019 | [Windows Server `EXE`](windows.md#installing-from-exe-installer), [Windows Server ZIP](windows.md#installing-from-zip-archive) |
| Windows 10 2019.03 | [Windows `EXE`](windows.md#installing-from-exe-installer), [Windows ZIP](windows.md#installing-from-zip-archive) |

## Install on macOS (packages)
### Install on macOS (packages)

| Operating System | Installation instructions |
| ------------------- | --------------------------------------------- |
| macOS | [Homebrew](macos.md#installing-from-homebrew) |

## Compile from source (Linux, Windows, FreeBSD, macOS)
### Compile from source (Linux, Windows, FreeBSD, macOS)

| Operating system | Installation instructions |
| ---------------- | ----------------------------------------------------------- |
| Linux, FreeBSD | [Compile from source](sources/build-and-install.md) |
| macOS | [Compile from source](macos.md#compile-from-source) |
| Windows | [Compile from Source](windows.md#compile-from-source) |

## Sandbox environment

If you are interested in learning about Fluent Bit you can try out the sandbox environment:

{% embed url="https://play.instruqt.com/embed/Fluent/tracks/fluent-bit-getting-started-101?token=em_S2zOzhhDQepM0vDS" %}
Fluent Bit sandbox environment
{% endembed %}

## Enterprise packages
### Enterprise packages

Fluent Bit packages are also provided by [enterprise providers](https://fluentbit.io/enterprise) for older end of life versions, Unix systems, and additional support and features including aspects like CVE backporting.
Fluent Bit packages are also provided by [enterprise providers](https://fluentbit.io/enterprise) for older end of life versions, Unix systems, or for additional support and features including aspects like CVE backporting.

Check warning on line 69 in installation/getting-started-with-fluent-bit.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[FluentBit.Acronyms] Spell out 'CVE', if it's unfamiliar to the audience.

Raw Output:
{"message": "[FluentBit.Acronyms] Spell out 'CVE', if it's unfamiliar to the audience.", "location": {"path": "installation/getting-started-with-fluent-bit.md", "range": {"start": {"line": 69, "column": 206}}}, "severity": "INFO"}