From 2f3ba1335c7e5b22ee8418d28b410097f12d27b3 Mon Sep 17 00:00:00 2001 From: "Alex Ellis (OpenFaaS Ltd)" Date: Sun, 5 Jan 2020 12:02:50 +0000 Subject: [PATCH] Update docs for #15 Signed-off-by: Alex Ellis (OpenFaaS Ltd) --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7db8a22..b4a09d5 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,7 @@ Done: * [x] Clear / remove containers and tasks with SIGTERM / SIGINT * [x] Determine armhf/arm64 containers to run for gateway * [x] Configure `basic_auth` to protect the OpenFaaS gateway and faas-containerd HTTP API +* [x] Setup custom working directory for faasd `/run/faasd/` ## Tutorial: Get started on armhf / Raspberry Pi @@ -120,7 +121,7 @@ sudo curl -fSLs "https://github.com/alexellis/faasd/releases/download/0.4.2/faas ### At run-time -Look in `hosts` in the current working folder to get the IP for the gateway or Prometheus +Look in `hosts` in the current working folder or in `/run/faasd/` to get the IP for the gateway or Prometheus ```sh 127.0.0.1 localhost @@ -142,12 +143,12 @@ Since faas-containerd uses containerd heavily it is not running as a container, * basic-auth - You will then need to get the basic-auth password, it is written to `$GOPATH/src/github.com/alexellis/faasd/basic-auth-password` if you followed the above instructions. -The default Basic Auth username is `admin`, which is written to `$GOPATH/src/github.com/alexellis/faasd/basic-auth-user`, if you wish to use a non-standard user then create this file and add your username (no newlines or other characters) + You will then need to get the basic-auth password, it is written to `/run/faasd/secrets/basic-auth-password` if you followed the above instructions. +The default Basic Auth username is `admin`, which is written to `/run/faasd/secrets/basic-auth-user`, if you wish to use a non-standard user then create this file and add your username (no newlines or other characters) #### Installation with systemd -* `faasd install` - install faasd and containerd with systemd, run in `$GOPATH/src/github.com/alexellis/faasd` +* `faasd install` - install faasd and containerd with systemd, this must be run from `$GOPATH/src/github.com/alexellis/faasd` * `journalctl -u faasd` - faasd systemd logs * `journalctl -u faas-containerd` - faas-containerd systemd logs