Skip to main content

Installation

From Sources​

Requirements:

  • Go 1.22+
  • C Toolchain
  • Rust and Cargo (edition 2021)
  • NodeJS

First fetch the source code:

git clone https://github.com/link-society/flowg
cd flowg

Then run the build system:

go install github.com/go-task/task/v3/cmd/task@latest
task build
sudo install -m 755 ./bin/flowg /usr/local/bin/flowg

Then, start the server with:

flowg serve \
  --auth-dir /var/lib/flowg/data/auth \
  --log-dir /var/lib/flowg/logs \
  --config-dir /var/lib/flowg/config \
  --http-bind 127.0.0.1:5080 \
  --syslog-bind 127.0.0.1:5514

NB: All the options are optional and default to the values shown above.

For more informations about the command line interface, please consult this document.

Using Docker​

docker run \
  -p 5080:5080/tcp \
  -p 5514:5514/udp \
  -v flowg-data:/data \
  linksociety/flowg:latest serve

Using Kubernetes​

First fetch the source code:

git clone https://github.com/link-society/flowg
cd flowg

Then deploy the Helm chart:

helm install flowg ./k8s/charts/flowg \
  --create-namespace \
  --namespace flowg-system \
  --wait

This will automatically deploy Fluentd alongside FlowG in order to collect logs from all pods.

Once deployed, you can forward the port of the WebUI and API to your localhost:

kubectl port-forward svc/flowg 5080:5080 --namespace flowg-system

Security considerations​

By default, the Syslog endpoint is open to everyone. If that behavior is undesirable, you can:

Configure Client certificate authentication​

By using the Syslog protocol tcp+tls instead of udp (the default), you can require Client certificate authentication:

flowg serve \
  --syslog-proto="tcp" \
  --syslog-tls \
  --syslog-tls-cert="/path/to/cert.pem" \
  --syslog-tls-key="/path/to/cert.key" \
  --syslog-tls-auth

Configure allowed origins​

Otherwise, you can restrict which IP address (or range) will be allowed:

flowg serve \
  --syslog-allow-origin="127.0.0.1" \
  --syslog-allow-origin="192.168.1.0/24"

Or via an environment variable:

export FLOWG_SYSLOG_ALLOW_ORIGINS="127.0.0.1,192.168.1.0/24"
flowg serve

Next Steps​

Once deployed, FlowG creates a default pipeline and a default account with the credentials root / root.

You now have access to: