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

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!

• 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)

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

If you're on a Mac and use Homebrew:

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:

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

Install and run the Fn Client for Windows.

Head over to our releases and download it.

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.

First, start up a Fn server locally:

or if you are on podman/rancher which you need to use a volume

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 here.

Most Linux systems have SELinux enabled and FnServer supports running on SELinux.

Functions are small but powerful blocks of code that generally do one simple thing. Forget about monoliths when using functions, just focus on the task that you want the function to perform. Our CLI tool will help you get started quickly.

Let's create your function. You can use any runtime (ie go, node, java, python, etc.) hello will be the name of your function as well as create a directory called hello. You can name your function anything.

We need to create an "app" which acts as a top-level collection of functions and other elements:

Deploy your function:

Note: --local flag will skip the push to remote container registry making local development faster

Now let's actually run your function using the invoke command:

That's it! You just deployed and ran your first function! Try updating the function code in func.go (or .js, .java, etc.) then deploy it again to see the change.

• Visit Fn tutorials for step-by-step guides to creating apps with Fn. These tutorials range from introductory to more advanced.
• See our full documentation
• View our YouTube Channel
• View our API Docs
• Check out our sub-projects: Flow, UI, FnLB
• For a full presentation with lots of content you can use in your own presentations, see The Fn Project Presentation Master

• Ask your question on StackOverflow and tag it with fn

• Join our Slack Community
• See our new Community Page
• Learn how to contribute
• Find issues and become a contributor
• Join us at one of our Fn Events or even speak at one!
• Coming in Q1'19: Regularly scheduled planning meetings for contributing to the Fn Project

• Blog
• Twitter
• YouTube
• Events