fnproject /fn

The container native, cloud agnostic serverless platform.

★ 5,949⑂ 403👁 179⑃ 976● 654▤ 5
GoApache-2.0Created 2017-07-18fnproject.io
Download: 0.3.250.3.25 ↓0.3.252017-07-26
+0
Daily
5,949
stars
403
forks
179
watchers
976
prs
654
issues
5
releases

README

!Fn Project

Quickstart  |  Tutorials  |   Docs  |  API  |  Operating  |  Flow  |  UI

 


 Welcome
Fn is an event-driven, open source, Functions-as-a-Service (FaaS) compute platform that you can run anywhere. Some of its key features:

 Open Source
 Native Docker: use any Docker container as your Function
 Supports all languages
 Run anywhere
   Public, private and hybrid cloud
   Import Lambda functions and run them anywhere
 Easy to use for developers
 Easy to manage for operators
 Written in Go
 Simple yet powerful extensibility

The fastest way to experience Fn is to follow the quickstart below, or you can jump right to our full documentation, API Docs, or hit us up in our Slack Community or Community Page!


 Quickstart

 Pre-requisites

 Docker 17.10.0-ce or later, Podman 5.7.0 or later installed and running
 Docker Hub account (or other Docker-compliant registry) (Not required for local development)
 Logged into Registry: ie docker login (Not required for local development)

 Install CLI tool

The command line tool isn't required, but it makes things a lot easier. There are a few options to install it:

 Option 1. Homebrew - macOS

If you're on a Mac and use Homebrew:

sh
brew update && brew install fn


 Option 2. Shell script - Linux and macOS

This one works on Linux and macOS (partially on Windows).

If you are running behind a proxy first set your http_proxy and https_proxy environment vars:

sh
curl -LSs https://raw.githubusercontent.com/fnproject/cli/master/install | sh


This will download a shell script and execute it. If the script asks for a password, that is because it invokes sudo.

 Option 3. Install the Windows CLI
Install and run the Fn Client for Windows.


 Option 4. Download the bin - Linux, macOS and Windows
Head over to our releases and download it.

 Before you start

If you are using Podman or Rancher desktop, it is recommended use a volume. The volume will be used by FnServer
to create unix socket file to communicate to other Fn containers.

The volume will be created automatically when you use "--iofs-dir" option in "fn start" and specify the volume name (e.g. fniofsvol).

If you want to create volume manually, you could do:
docker volume create --opt device=tmpfs --opt type=tmpfs --opt o=size=2M,dev,noexec 

The docker command is provided by podman or rancher desktop in this case.

 Run Fn Server

First, start up a Fn server locally:

sh
fn start

or if you are on podman/rancher which you need to use a volume
sh
fn start --iofs-dir 


iofs-dir allows you to specify a volume (which is required for Podman or Rancher case), or any directory in the
host-vm (for Docker Desktop) if you want to use a specific directory to host the unix socket file. It is usually
not a concern for Docker users.

This will start Fn in single server mode, using an embedded database and message queue. You can find all the
configuration options here. If you are on Windows, check her

Top issues

Latest release

0.3.25 0.3.25 2017-07-26

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON