You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+33-30Lines changed: 33 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,6 +71,8 @@ To self-host, see [contributing](#contributing). A `.tar.gz` archive of the fron
71
71
72
72
## Tutorial
73
73
74
+
> TL;DR: Setup OIDC authentication, configure the backend, start the backend, open up a port on the firewall, and connect using the frontend
75
+
74
76
### 1. Setting up Authentication
75
77
76
78
bofied uses [OpenID Connect](https://en.wikipedia.org/wiki/OpenID_Connect) for authentication, which means you can use almost any authentication provider, both self-hosted and as a service, that you want to. We've created a short tutorial video which shows how to set up [Auth0](https://auth0.com/) for this purpose, but feel free to use something like [Ory](https://github.com/ory/hydra) if you prefer a self-hosted solution:
@@ -103,17 +105,17 @@ $ ip -4 a
103
105
104
106
In the following, we'll assume that `192.168.178.147` is the IP address of this node.
105
107
106
-
### 4 (Option 1): Starting the Backend (Containerized)
108
+
### 4. Starting the Backend
107
109
108
-
Using Docker (or an alternative like Podman), you can now easily start & configure the backend; see the [Reference](#reference) for more configuration parameters:
110
+
Next up is starting the backend. It is available both in containerized and static binary form; see the [Reference](#reference) for more configuration parameters:
First, set up a config file at `~/.local/share/bofied/etc/bofied/bofied-backend-config.yaml`; see the [Reference](#reference) for more configuration parameters:
Alternatively, as described in [About the Frontend](#about-the-frontend), you can also choose to self-host. Once you're on the page, you should be presented with the following setup page:
203
+
Alternatively, as described in [Frontend](#frontend), you can also choose to self-host. Once you're on the page, you should be presented with the following setup page:
201
204
202
205

203
206
@@ -245,7 +248,7 @@ Click on an image to see a larger version.
245
248
246
249
### Command Line Arguments
247
250
248
-
```shell
251
+
```console
249
252
$ bofied-backend --help
250
253
bofied is a network boot server. It provides everything you need to PXE boot a node, from a (proxy)DHCP server for PXE service to a TFTP and HTTP server to serve boot files.
251
254
@@ -266,7 +269,7 @@ Flags:
266
269
--proxyDHCPListenAddress string Listen address for proxyDHCP server (default ":4011")
267
270
-p, --pureConfig Configuration Prevent usage of stdlib in configuration file, even if enabled in Configuration function
268
271
-s, --skipStarterDownload Don't initialize by downloading the starter on the first run
269
-
--starterURL string Download URL to a starter .tar.gz archive; the default chainloads https://netboot.xyz/ (default "https://github.com/pojntfx/ipxe-binaries/releases/download/latest/ipxe.tar.gz")
272
+
--starterURL string Download URL to a starter .tar.gz archive; the default chainloads https://netboot.xyz/ (default "https://github.com/pojntfx/ipxe-binaries/releases/latest/download/ipxe.tar.gz")
270
273
--tftpListenAddress string Listen address for TFTP server (default ":69")
271
274
-d, --workingDir string Working directory (default "/home/pojntfx/.local/share/bofied/var/lib/bofied")
272
275
```
@@ -402,7 +405,7 @@ To contribute, please use the [GitHub flow](https://guides.github.com/introducti
402
405
403
406
To build and start a development version of bofied locally, run the following:
0 commit comments