Skip to content

Commit

Permalink
Update script URL for edge
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
  • Loading branch information
alexellis committed Sep 23, 2024
1 parent 5576382 commit 038eb91
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 7 deletions.
33 changes: 26 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,19 +121,38 @@ View sample pages, reviews and testimonials on Gumroad:

["Serverless For Everyone Else"](https://openfaas.gumroad.com/l/serverless-for-everyone-else)

### Deploy faasd-pro
### Deploy OpenFaaS Edge (commercial distribution of faasd)

faasd-pro is available for commercial licensing and for individuals to use via GitHub Sponsors on a 25USD/mo and higher tier.
OpenFaaS Edge is a commercial distribution of faasd, with enhancements and additional features from OpenFaaS Pro. The [OpenFaaS Pro EULA applies](https://github.com/openfaas/faas/blob/master/pro/EULA.md).

You get unlimited function deployments, private DNS support, airgap installations and can create multiple namespaces.
* Upgraded Cron Connector, JetStream Queue Worker and Classic Scale to Zero from OpenFaaS Standard
* No limit on number of functions
* Configure private DNS servers
* Airgap-friendly with installation bundled in an OCI image
* Multiple namespace support

```bash
curl -sLS https://raw.githubusercontent.com/openfaas/faasd/refs/heads/master/hack/install-pro.sh -o install-pro.sh
chmod +x install-pro.sh
This version is intended for resale as part of a wider solution, and to be deployed both into industrial and on-premises environments.

Individual [GitHub Sponsors of OpenFaaS](https://github.com/sponsors/openfaas) (25 USD / mo and higher) can use OpenFaaS Edge for personal use.

sudo -E ./install-pro.sh
You can install OpenFaaS Edge with the following script:

```bash
curl -sLSf \
https://raw.githubusercontent.com/openfaas/faasd/refs/heads/master/hack/install-edge.sh \
-o install-edge.sh && \
chmod +x install-edge.sh
sudo -E ./install-edge.sh
```

*For an offline installation*

Copy the OCI bundle and the install-edge.sh script to the remote server.

Then mirror the various images from docker-compose.yaml into your private registry, and update the references from i.e. `image: ghcr.io/openfaasltd/gateway` to the equivalents in your registry.

If your system is unable to install apt, yum, or pacman packages, due to limited network access, then set the `SKIP_OS` environment to 1. The list of packages is available in the `install_required_packages` section of the script.

### Deploy faasd CE

faasd-ce supports 15 functions and needs a computer with a stable Internet connection to run. There are some restrictions on commercial use, but [individuals and certain small businesses can use it for free](EULA.md).
Expand Down
4 changes: 4 additions & 0 deletions hack/install-pro.sh → hack/install-edge.sh
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ install_required_packages() {
fi
}

echo "OpenFaaS Edge (based upon faasd and OpenFaaS Standard)"
echo ""
echo ""

echo "1. Installing required OS packages, set SKIP_OS=1 to skip this step"
echo ""

Expand Down

0 comments on commit 038eb91

Please sign in to comment.