first push

2026-06-04 16:20:56 -05:00
parent a663de4f29
commit 392ae7bbe3
111 changed files with 5312 additions and 0 deletions
@@ -0,0 +1,87 @@
+---
+type: project
+status: active
+source: git.alwisp.com
+repo: jason/stepview
+repo_url: https://git.alwisp.com/jason/stepview
+language: TypeScript
+branch: main
+tags:
+  - repo
+  - jason
+  - mpm
+updated: 2026-05-29
+---
+
+# stepview
+
+**Repository:** [jason/stepview](https://git.alwisp.com/jason/stepview) · branch `main` · TypeScript
+
+## Summary
+
+StepView: self-hosted in-browser 3D STEP file viewer — renders .step/.stp files via OpenCascade (WASM) and three.js, deployed as a Docker container on Unraid
+
+## Current status
+
+Active. Synced from Gitea on 2026-05-29.
+
+## Documentation overview
+
+_Source: INSTALL.md_
+
+# StepView — Unraid Installation Guide
+
+This guide covers the full deployment path: building the Docker image via the Gitea CI runner, then installing and configuring the container through the Unraid Docker GUI.
+
+---
+
+## Table of Contents
+
+1. [Prerequisites](#1-prerequisites)
+2. [Build Pipeline — Gitea Actions](#2-build-pipeline--gitea-actions)
+3. [Unraid — Add the Registry](#3-unraid--add-the-registry)
+4. [Unraid — Install the Container](#4-unraid--install-the-container)
+5. [Environment Variables Reference](#5-environment-variables-reference)
+6. [Volume Paths Reference](#6-volume-paths-reference)
+7. [First-Run Steps](#7-first-run-steps)
+8. [Upgrading](#8-upgrading)
+9. [Backups](#9-backups)
+10. [Troubleshooting](#10-troubleshooting)
+
+---
+
+## 1. Prerequisites
+
+| Requirement | Notes |
+|---|---|
+| Unraid 6.12 or later | Earlier versions work but UI steps may differ slightly |
+| Gitea instance | Any version with Actions support (1.19+) |
+| Gitea Actions runner | Registered to your Gitea instance, labeled `ubuntu-latest` |
+| Docker runner image | `catthehacker/ubuntu:act-latest` (already in your workflow) |
+| `REGISTRY_USER` secret | Set in Gitea repo → Settings → Secrets |
+| `REGISTRY_TOKEN` secret | An access token with `package:write` scope on `registry.alwisp.com` |
+
+---
+
+## 2. Build Pipeline — Gitea Actions
+
+The workflow at `.gitea/workflows/docker-build.yml` runs automatically on every push to `main`. It builds the image and pushes it to:
+
+```
+registry.alwisp.com/<OWNER>/stepview:latest
+```
+
+### Verify the secrets exist
+
+In your Gitea repository, go to **Settings → Secrets and Variables → Actions** and confirm both of these are set:
+
+| Secret name | Value |
+|---|---|
+| `REGISTRY_USER` | Your registry username |
+| `REGISTRY_TOKEN` | Registry access token (read/write) |
+
+…(truncated — see repo)
+
+## Notes
+
+- Project file auto-created from repo documentation.