Skip to content

Commit 06612d8

Browse files
committed
chore: add appjail director support & regen docs
1 parent c9bba9f commit 06612d8

3 files changed

Lines changed: 80 additions & 23 deletions

File tree

Containerfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ARG FREEBSD_ARCH=amd64
1111
ARG PACKAGES="ca_root_nss"
1212
ARG UPSTREAM_URL="https://api.github.com/repos/openspeedtest/Docker-Image/releases/latest"
1313
ARG UPSTREAM_JQ=".tag_name"
14-
ARG HEALTHCHECK_ENDPOINT="http://localhost:3005/daemonless-ping"
14+
ARG HEALTHCHECK_ENDPOINT="http://localhost:3000/daemonless-ping"
1515

1616
ENV HEALTHCHECK_URL="${HEALTHCHECK_ENDPOINT}"
1717

@@ -26,7 +26,7 @@ LABEL org.opencontainers.image.title="OpenSpeedTest" \
2626
org.opencontainers.image.vendor="daemonless" \
2727
org.opencontainers.image.authors="daemonless" \
2828
io.daemonless.category="Utilities" \
29-
io.daemonless.port="3005" \
29+
io.daemonless.port="3000" \
3030
io.daemonless.arch="${FREEBSD_ARCH}" \
3131
io.daemonless.base="nginx" \
3232
io.daemonless.upstream-url="${UPSTREAM_URL}" \
@@ -53,6 +53,6 @@ COPY root/ /
5353
RUN chmod +x /etc/cont-init.d/* 2>/dev/null || true
5454

5555
# --- Expose (Injected by Generator) ---
56-
EXPOSE 3005
56+
EXPOSE 3000
5757

5858
# --- Volumes (Injected by Generator) ---

README.md

Lines changed: 74 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,28 @@ Source: dbuild templates
55

66
# OpenSpeedTest
77

8+
[![Build Status](https://img.shields.io/github/actions/workflow/status/daemonless/openspeedtest/build.yaml?style=flat-square&label=Build&color=green)](https://github.com/daemonless/openspeedtest/actions)
9+
[![Last Commit](https://img.shields.io/github/last-commit/daemonless/openspeedtest?style=flat-square&label=Last+Commit&color=blue)](https://github.com/daemonless/openspeedtest/commits)
10+
811
Self-hosted HTML5 Network Speed Test on FreeBSD.
912

1013
| | |
1114
|---|---|
12-
| **Port** | 3005 |
15+
| **Port** | 3000 |
1316
| **Registry** | `ghcr.io/daemonless/openspeedtest` |
14-
| **Docs** | [daemonless.io/images/openspeedtest](https://daemonless.io/images/openspeedtest/) |
1517
| **Source** | [https://github.com/openspeedtest/Speed-Test](https://github.com/openspeedtest/Speed-Test) |
1618
| **Website** | [https://openspeedtest.com/](https://openspeedtest.com/) |
1719

20+
## Version Tags
21+
22+
| Tag | Description | Best For |
23+
| :--- | :--- | :--- |
24+
| `latest` | **Upstream Binary**. Built from official release. | Most users. Matches Linux Docker behavior. |
25+
26+
## Prerequisites
27+
28+
Before deploying, ensure your host environment is ready. See the [Quick Start Guide](https://daemonless.io/guides/quick-start) for host setup instructions.
29+
1830
## Deployment
1931

2032
### Podman Compose
@@ -29,21 +41,59 @@ services:
2941
- PGID=1000
3042
- TZ=UTC
3143
ports:
32-
- 3005:3005
44+
- 3000:3000
3345
restart: unless-stopped
3446
```
3547
48+
### AppJail Director
49+
50+
**.env**:
51+
52+
```
53+
DIRECTOR_PROJECT=openspeedtest
54+
PUID=1000
55+
PGID=1000
56+
TZ=UTC
57+
```
58+
59+
**appjail-director.yml**:
60+
61+
```yaml
62+
options:
63+
- virtualnet: ':<random> default'
64+
- nat:
65+
services:
66+
openspeedtest:
67+
name: openspeedtest
68+
options:
69+
- container: 'boot args:--pull'
70+
oci:
71+
user: root
72+
environment:
73+
- PUID: !ENV '${PUID}'
74+
- PGID: !ENV '${PGID}'
75+
- TZ: !ENV '${TZ}'
76+
```
77+
78+
**Makejail**:
79+
80+
```
81+
ARG tag=latest
82+
83+
OPTION overwrite=force
84+
OPTION from=ghcr.io/daemonless/openspeedtest:${tag}
85+
```
86+
3687
### Podman CLI
3788

3889
```bash
3990
podman run -d --name openspeedtest \
40-
-p 3005:3005 \
41-
-e PUID=@PUID@ \
42-
-e PGID=@PGID@ \
43-
-e TZ=@TZ@ \
91+
-p 3000:3000 \
92+
-e PUID=1000 \
93+
-e PGID=1000 \
94+
-e TZ=UTC \
4495
ghcr.io/daemonless/openspeedtest:latest
4596
```
46-
Access at: `http://localhost:3005`
4797

4898
### Ansible
4999

@@ -55,29 +105,35 @@ Access at: `http://localhost:3005`
55105
state: started
56106
restart_policy: always
57107
env:
58-
PUID: "@PUID@"
59-
PGID: "@PGID@"
60-
TZ: "@TZ@"
108+
PUID: "1000"
109+
PGID: "1000"
110+
TZ: "UTC"
61111
ports:
62-
- "3005:3005"
112+
- "3000:3000"
63113
```
64114
65-
## Configuration
115+
Access at: `http://localhost:3000`
116+
117+
## Parameters
118+
66119
### Environment Variables
67120

68121
| Variable | Default | Description |
69122
|----------|---------|-------------|
70123
| `PUID` | `1000` | User ID for the application process |
71124
| `PGID` | `1000` | Group ID for the application process |
72125
| `TZ` | `UTC` | Timezone for the container |
126+
73127
### Ports
74128

75129
| Port | Protocol | Description |
76130
|------|----------|-------------|
77-
| `3005` | TCP | |
131+
| `3000` | TCP | Web UI |
132+
133+
**Architectures:** amd64
134+
**User:** `bsd` (UID/GID via PUID/PGID, defaults to 1000:1000)
135+
**Base:** FreeBSD 15.0
78136

79-
## Notes
137+
---
80138

81-
- **Architectures:** amd64
82-
- **User:** `bsd` (UID/GID set via PUID/PGID)
83-
- **Base:** Built on `ghcr.io/daemonless/base` (FreeBSD)
139+
Need help? Join our [Discord](https://discord.gg/Kb9tkhecZT) community.

compose.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ x-daemonless:
1111
user: "bsd"
1212
mlock: false
1313
upstream_binary: true
14-
14+
appjail: true
15+
1516
docs:
1617
env:
1718
PUID: "User ID for the application process"
@@ -32,4 +33,4 @@ services:
3233
- TZ=UTC
3334

3435
ports:
35-
- "3005:3000"
36+
- "3000:3000"

0 commit comments

Comments
 (0)