mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 10:59:59 +00:00
kevinveenbirkenbachandClaude Opus 5
4986e80dd4
The Production block never set one. inventory provision writes only
ansible_connection for a local host, so DOMAIN_PRIMARY stayed at the
group_vars default of infinito.localhost and the deployment served a zone its
own resolver knows nothing about. CoreDNS templates answers for
INFINITO_DOMAIN_RE and nothing else, so every lookup of the deployment's own
name came back NXDOMAIN.
Mastodon is where that surfaced. tootctl accounts create validates the address
through EmailMxValidator, which resolves MX and then, for the domain itself,
A and AAAA. All six queries returned NXDOMAIN in run 33574056480, the
validator recorded email :unreachable, and the admin account was never created.
Only the guide rows were affected: the matrix rows write
DOMAIN_PRIMARY: "{{ lookup('env', 'INFINITO_DOMAIN') }}" into their host_vars
and resolve fine.
The template now carries DOMAIN=<your-domain> in both the host and the
container form and threads it into --vars, with the container form passing it
through the docker run boundary as well. The two guide runners substitute it
the way they already substitute the SSH key, so the replay deploys under
INFINITO_DOMAIN like every other CI deploy. compose_deploy.sh moves its env
load ahead of the substitutions to have the value; host_deploy.sh had no env
load at all.
A production reader is asked for a domain now instead of silently inheriting
infinito.localhost, which no real deployment wants either. The shipped default
keeps its value: sys-svc-nss documents that *.localhost resolves through the
myhostname NSS module without any zone, and host-side tasks lean on it.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
151 lines
7.1 KiB
Markdown
151 lines
7.1 KiB
Markdown
# Dashboard
|
|
|
|
## Description
|
|
|
|
A lightweight, Docker-powered UI framework that offers Infinito.Nexus users a unified interface to access all their applications in one intuitive dashboard. 🚀
|
|
|
|
## Overview
|
|
|
|
Tailored for creative professionals and developers, this role streamlines the process of setting up a portfolio site. It automates tasks such as Docker container configuration, dynamic routing via NGINX, and repository integration, so you can concentrate on perfecting your content and design. Enjoy a responsive layout and easy-to-modify YAML files that let you rapidly update your online presence without deep technical intervention.
|
|
|
|
## Cosmos
|
|
|
|
The diagram places Dashboard in the Infinito.Nexus cosmos: the components it deploys (capabilities), the central services it consumes (dependencies), and its outward reach (federation and bridged external networks).
|
|
|
|
```mermaid
|
|
flowchart LR
|
|
subgraph deps [Dependencies]
|
|
dep_svc_net_tor["svc-net-tor 🐳🐝"]
|
|
dep_web_app_keycloak["web-app-keycloak 🐳🐝"]
|
|
dep_web_app_matomo["web-app-matomo 🐳🐝"]
|
|
dep_web_app_prometheus["web-app-prometheus 🐳🐝"]
|
|
dep_web_svc_asset["web-svc-asset 💻"]
|
|
dep_web_svc_cdn["web-svc-cdn 🐳🐝"]
|
|
dep_web_svc_css["web-svc-css 💻"]
|
|
dep_web_svc_logout["web-svc-logout 🐳🐝"]
|
|
dep_web_svc_simpleicons["web-svc-simpleicons 🐳🐝"]
|
|
end
|
|
subgraph role [web-app-dashboard 🐳🐝]
|
|
svc_sso["sso"]
|
|
svc_asset["asset"]
|
|
svc_cdn["cdn"]
|
|
svc_simpleicons["simpleicons"]
|
|
svc_logout["logout"]
|
|
svc_matomo["matomo"]
|
|
svc_dashboard["dashboard"]
|
|
svc_css["css"]
|
|
svc_javascript["javascript"]
|
|
svc_prometheus["prometheus"]
|
|
svc_tor["tor"]
|
|
end
|
|
subgraph dependents [Dependents]
|
|
dpt_web_app_akaunting["web-app-akaunting 🐳🐝"]
|
|
dpt_web_app_baserow["web-app-baserow 🐳🐝"]
|
|
dpt_web_app_bigbluebutton["web-app-bigbluebutton 🐳🐝"]
|
|
dpt_web_app_bluesky["web-app-bluesky 🐳🐝"]
|
|
dpt_web_app_bookwyrm["web-app-bookwyrm 🐳🐝"]
|
|
dpt_web_app_bridgy_fed["web-app-bridgy-fed 🐳🐝"]
|
|
dpt_web_app_checkmk["web-app-checkmk 🐳🐝"]
|
|
dpt_web_app_chess["web-app-chess 🐳🐝"]
|
|
dpt_web_app_confluence["web-app-confluence 🐳🐝"]
|
|
dpt_web_app_decidim["web-app-decidim 🐳🐝"]
|
|
dpt_web_app_discourse["web-app-discourse 🐳🐝"]
|
|
dpt_web_app_erpnext["web-app-erpnext 🐳🐝"]
|
|
dpt_more["..."]
|
|
end
|
|
dep_svc_net_tor -. "0..1" .-> svc_tor
|
|
dep_web_app_keycloak -. "0..1" .-> svc_sso
|
|
dep_web_app_matomo -. "0..1" .-> svc_matomo
|
|
dep_web_app_prometheus -. "0..1" .-> svc_prometheus
|
|
dep_web_svc_asset -. "0..1" .-> svc_asset
|
|
dep_web_svc_cdn -- "1:1" --> svc_cdn
|
|
dep_web_svc_css -. "0..1" .-> svc_css
|
|
dep_web_svc_logout -. "0..1" .-> svc_logout
|
|
dep_web_svc_simpleicons -. "0..1" .-> svc_simpleicons
|
|
svc_sso -- "1:1" --> dpt_more
|
|
svc_sso -. "0..1" .-> dpt_web_app_akaunting
|
|
svc_sso -. "0..1" .-> dpt_web_app_baserow
|
|
svc_sso -. "0..1" .-> dpt_web_app_bigbluebutton
|
|
svc_sso -. "0..1" .-> dpt_web_app_bluesky
|
|
svc_sso -. "0..1" .-> dpt_web_app_bookwyrm
|
|
svc_sso -. "0..1" .-> dpt_web_app_bridgy_fed
|
|
svc_sso -. "0..1" .-> dpt_web_app_checkmk
|
|
svc_sso -. "0..1" .-> dpt_web_app_chess
|
|
svc_sso -. "0..1" .-> dpt_web_app_confluence
|
|
svc_sso -. "0..1" .-> dpt_web_app_decidim
|
|
svc_sso -. "0..1" .-> dpt_web_app_discourse
|
|
svc_sso -. "0..1" .-> dpt_web_app_erpnext
|
|
```
|
|
|
|
Solid `1:1` edges are fixed relationships; dashed `0..1` edges are conditional (enabled only in matching deployments); red `0..0` edges are turned off in this role. Node markers show the role's deploy modes (💻 host, 🐳 compose, 🐝 swarm); ❌ marks a service that is explicitly turned off, and ⚙️ an Ansible role dependency declared in `meta/main.yml`.
|
|
|
|
## Purpose
|
|
|
|
The purpose of tthis role is to simplify the deployment and management of a personal or professional portfolio. By focusing on usability and a clean presentation, the role helps you:
|
|
|
|
- Quickly launch a professional-looking website.
|
|
- Customize and update your portfolio content effortlessly.
|
|
- Integrate seamlessly with complementary roles for Docker Compose and web server management.
|
|
- Reduce manual configuration and maintenance tasks.
|
|
|
|
## Features
|
|
|
|
- **Unified Navigation**: Central menu bar with dynamic categories for all registered applications.
|
|
- **Customizable Tiles**: Showcase applications with title, description, and icons, fully configurable via YAML.
|
|
- **Responsive Design**: Optimized for desktop, tablet & mobile, built on Bootstrap.
|
|
- **Interactive Icons**: Automatic integration of Simple Icons for popular brands and tools.
|
|
- **Seamless IFrame Embedding**: Launch apps directly within the UI or open in new tabs.
|
|
- **YAML-Driven Configuration**: Define all content & structure easily in `config.yaml`.
|
|
- **Fast Access**: Automatic cache management ensures lightning-fast load times.
|
|
|
|
## Quick Setup
|
|
|
|
### Development
|
|
|
|
Clone, set up the workstation, and deploy Dashboard onto the local stack:
|
|
|
|
```bash
|
|
git clone https://github.com/infinito-nexus/core.git
|
|
cd core
|
|
make onboard
|
|
make compose-deploy mode=reinstall apps=web-app-dashboard full_cycle=false
|
|
```
|
|
|
|
### Production
|
|
|
|
Run the published image to provision the inventory and deploy Dashboard to a managed server (the mounted volume persists the inventory):
|
|
|
|
```bash
|
|
APP=web-app-dashboard
|
|
HOST=<your-server>
|
|
DOMAIN=<your-domain>
|
|
TLS_MODE=self_signed
|
|
SSH_PUBLIC_KEY="<your-ssh-public-key>"
|
|
|
|
docker run --rm -it \
|
|
-v "$PWD/inventories:/etc/infinito.nexus/inventories" \
|
|
-e APP="$APP" -e HOST="$HOST" -e DOMAIN="$DOMAIN" -e TLS_MODE="$TLS_MODE" -e SSH_PUBLIC_KEY="$SSH_PUBLIC_KEY" \
|
|
ghcr.io/infinito-nexus/core/debian bash -c '
|
|
INVENTORY=/etc/infinito.nexus/inventories/production
|
|
infinito administration inventory provision "$INVENTORY" \
|
|
--inventory-file "$INVENTORY/devices.yml" \
|
|
--host "$HOST" \
|
|
--include "$APP" \
|
|
--vars "{\"TLS_MODE\": \"$TLS_MODE\", \"DOMAIN_PRIMARY\": \"$DOMAIN\", \"users\": {\"administrator\": {\"authorized_keys\": [\"$SSH_PUBLIC_KEY\"]}}}" &&
|
|
infinito administration deploy dedicated "$INVENTORY/devices.yml" \
|
|
--password-file "$INVENTORY/.password" \
|
|
--diff -vv'
|
|
```
|
|
|
|
## Persona contract opt-outs
|
|
|
|
Both authenticated Playwright personas are blocked while `services.sso.enabled` is false. The dashboard's entire Keycloak integration is the browser-side `oidc.js` bundle, and `DASHBOARD_JS_FILES` in `vars/main.yml` ships that file only when SSO is enabled, so with SSO off the page renders neither a Login link nor a logout control.
|
|
|
|
port-ui is a tile launcher with no admin tier, so the `administrator` persona has no admin-only surface to assert against beyond the same login chain. With SSO enabled both personas run.
|
|
|
|
## Credits
|
|
|
|
Implemented by **[Kevin Veen-Birkenbach](https://www.veen.world)**.
|
|
Part of the [Infinito.Nexus Project](https://s.infinito.nexus/code) and maintained by [Kevin Veen-Birkenbach](https://www.veen.world).
|
|
Licensed under the [Infinito.Nexus Community License (Non-Commercial)](https://s.infinito.nexus/license).
|