openfaas-cloud

(โ˜… 769)

The Multi-user OpenFaaS Platform

Showing a partial file list โ€” download the zip above to see everything.

  • .DEREK.yml
  • .gitignore
  • aws.yml
  • buildshiprun_limits.yml
  • CONTRIBUTING.md
  • CUSTOMERS
  • gateway_config.yml
  • github.yml
  • gitlab.yml
  • go.mod
  • go.sum
  • LICENSE
  • Makefile
  • PRIVACY.md
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/openfaas/openfaas-cloud

Downloads the entire project code from GitHub to your computer.

cd openfaas-cloud

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f edge-auth/Dockerfile -t openfaas-cloud .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 openfaas-cloud

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd dashboard/client

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
cd audit-event

This project's files live in a subfolder, so move into it first.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

โœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation