Skip to content

Commit 6cae594

Browse files
committed
docs: Use moderncontainer terminology and better explanation for frontend hosting
Signed-off-by: Felicitas Pojtinger <[email protected]>
1 parent 84f515e commit 6cae594

File tree

1 file changed

+28
-11
lines changed

1 file changed

+28
-11
lines changed

README.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,29 +28,46 @@ It enables you to:
2828

2929
### Containerized
3030

31-
You can get the Docker container like so:
31+
You can get the OCI image like so:
3232

33-
```shell
34-
$ docker pull pojntfx/bofied-backend
33+
```console
34+
$ podman pull ghcr.io/pojntfx/bofied-backend
3535
```
3636

3737
### Natively
3838

39-
If you prefer a native installation, static binaries are also available on [GitHub releases](https://github.com/pojntfx/bofied/releases).
39+
Static binaries are available on [GitHub releases](https://github.com/pojntfx/bofied/releases).
4040

41-
You can install them like so:
41+
On Linux, you can install them like so:
4242

43-
```shell
44-
$ curl -L -o /tmp/bofied-backend https://github.com/pojntfx/bofied/releases/latest/download/bofied-backend.linux-$(uname -m)
43+
```console
44+
$ curl -L -o /tmp/bofied-backend "https://github.com/pojntfx/bofied/releases/latest/download/bofied-backend.linux-$(uname -m)"
4545
$ sudo install /tmp/bofied-backend /usr/local/bin
46-
$ sudo setcap cap_net_bind_service+ep /usr/local/bin/bofied-backend # This allows rootless execution
46+
$ sudo setcap cap_net_admin+ep /usr/local/bin/bofied-backend # This allows rootless execution
4747
```
4848

49-
### About the Frontend
49+
On macOS, you can use the following:
50+
51+
```console
52+
$ curl -L -o /tmp/bofied-backend "https://github.com/pojntfx/bofied/releases/latest/download/bofied-backend.darwin-$(uname -m)"
53+
$ sudo install /tmp/bofied-backend /usr/local/bin
54+
```
5055

51-
The frontend is also available on [GitHub releases](https://github.com/pojntfx/bofied/releases) in the form of a static `.tar.gz` archive; to deploy it, simply upload it to a CDN or copy it to a web server. For most users, this shouldn't be necessary though; thanks to [@maxence-charriere](https://github.com/maxence-charriere)'s [go-app package](https://go-app.dev/), bofied is a progressive web app. By simply visiting the [public deployment](https://pojntfx.github.io/bofied/) once, it will be available for offline use whenever you need it:
56+
On Windows, the following should work (using PowerShell as administrator):
5257

53-
[<img src="https://github.com/alphahorizonio/webnetesctl/raw/main/img/launch.png" width="240">](https://pojntfx.github.io/bofied/)
58+
```console
59+
PS> Invoke-WebRequest https://github.com/pojntfx/bofied-backend/releases/latest/download/bofied-backend.windows-x86_64.exe -OutFile \Windows\System32\bofied-backend.exe
60+
```
61+
62+
You can find binaries for more operating systems and architectures on [GitHub releases](https://github.com/pojntfx/bofied/releases).
63+
64+
### Frontend
65+
66+
The frontend is publicly accessible and can be opened in any browser. It's a [PWA](https://en.wikipedia.org/wiki/Progressive_web_app), meaning it will continue to work offline after your first visit:
67+
68+
<a href="https://pojntfx.github.io/bofied/"><img src="https://github.com/pojntfx/webnetesctl/raw/main/img/launch.png" alt="PWA badge" width="200"/></a>
69+
70+
To self-host, see [contributing](#contributing). A `.tar.gz` archive of the frontend, ready for deployment on any static web server, is available on [GitHub releases](https://github.com/pojntfx/bofied/releases).
5471

5572
## Tutorial
5673

0 commit comments

Comments
 (0)