docs: sync README, DEPLOY, CHANGELOG with tour fixes (canvg drop, non-root container, base pin)
This commit is contained in:
1 parent
86ac366136
commit
1078f74793
3 files changed
+17
-6
No files matched your search
@@ -21,10 +21,21 @@ Versions follow [Semantic Versioning](https://semver.org/).
|
||||
- **Responsive mobile** — full phone/tablet adaptation across all components.
|
||||
- **Project renamed** Zoosteo → Faunosteo across the whole codebase.
|
||||
|
||||
### Removed
|
||||
|
||||
- **`canvg` dependency** — PDF SVG rasterization now uses the browser's native `Image`/`canvas` pipeline (`src/pdf/render/svgToPng.ts`) instead of the `canvg` library.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **`pathology-editor.html` 404 in production** — it lived at the repo root, Vite never bundled it into `dist/`; moved to `public/` so it ships (LRN-029).
|
||||
- **Docker species caching** — `Cache-Control: no-cache` header added for `/species/` assets so an updated catalog is served fresh.
|
||||
- **nginx runner base image** pinned to `nginx:1.31-alpine` (was the floating `nginx:alpine` tag).
|
||||
|
||||
### Security
|
||||
|
||||
- **Docker container runs fully as non-root** (`USER nginx`) — `PORT` must now be `>=1024` (default `8080` unaffected).
|
||||
- **Supply-chain guard** — `.npmrc` gained `minimum-release-age=1440`, blocking install of package versions published less than 24h ago.
|
||||
- **User-imported SVGs sanitized** — the SVG editor and the standalone pathology editor now strip `<script>`/`<foreignObject>` nodes, `on*` event-handler attributes, and `javascript:` hrefs before inserting an imported SVG into the DOM.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -5,7 +5,8 @@ TLS. The container serves a static SPA bundle from `/usr/share/nginx/html`
|
||||
and a runtime-injected `env.js`; there is no backend, no database, no
|
||||
persistent server-side state. Praticien data lives in the browser
|
||||
(`sessionStorage` / `localStorage`) and in the exported PDFs themselves
|
||||
(JSON attached natively to each PDF).
|
||||
(JSON attached natively to each PDF). The container runs entirely as a
|
||||
non-root `nginx` user — no process is root after the image is built.
|
||||
|
||||
---
|
||||
|
||||
@@ -13,7 +14,7 @@ persistent server-side state. Praticien data lives in the browser
|
||||
|
||||
| Service | Image source | Port (container) | Port (host) | Role |
|
||||
| ------- | ----------------------------------------- | ---------------- | --------------- | ----------------------------------------------------------------------------------- |
|
||||
| `app` | local build (multi-stage `Dockerfile`) | `${PORT:-8080}` | `${PORT:-8080}` | Serves the SPA (`dist/`) + runtime `env.js`. nginx:alpine inside, SPA fallback to `index.html`. |
|
||||
| `app` | local build (multi-stage `Dockerfile`) | `${PORT:-8080}` | `${PORT:-8080}` | Serves the SPA (`dist/`) + runtime `env.js`. `nginx:1.31-alpine` inside, runs as non-root `nginx` user, SPA fallback to `index.html`. |
|
||||
|
||||
The host should publish only ports `22`, `80`, `443` to the internet. The
|
||||
container port (`8080` by default) should stay loopback-only — the host
|
||||
@@ -34,7 +35,7 @@ each one explicitly.
|
||||
| `APP_BRAND_NAME` | yes | `Faunosteo` | Header brand block, PDF header. Praticien-visible identity. |
|
||||
| `APP_FOOTER_NAME` | yes | `Faunosteo` | Footer copyright line. |
|
||||
| `APP_TAGLINE` | yes | `Outils pour ostéopathes animaliers` | Hero tagline on Home. |
|
||||
| `PORT` | no | `8080` | Container listen port. Override to relocate the loopback bind. |
|
||||
| `PORT` | no | `8080` | Container listen port. Must be `>=1024` — the container runs as a non-root `nginx` user and cannot bind privileged ports. |
|
||||
|
||||
No secrets are required — there is no API, no DB, no provider credential.
|
||||
The `.env` file is not sensitive but should still be `chmod 600` to keep
|
||||
@@ -176,7 +177,7 @@ VPS is the path:
|
||||
```bash
|
||||
cd ~/faunosteo
|
||||
git fetch origin
|
||||
git reset --hard origin/master # default branch is "master" on this remote
|
||||
git reset --hard origin/main # default branch is "main" on this remote
|
||||
docker compose up --build -d
|
||||
docker image prune -f # reclaim old build layers
|
||||
```
|
||||
|
||||
@@ -24,7 +24,7 @@ contract.
|
||||
- **Hierarchical findings tree** — per-zone picker with breadcrumb drill-down through the expert-authored catalog (26 zones for the horse), vet-referral badges on sensitive leaves, scope-disclaimer modal once per session
|
||||
- **Vertebra picker** — region tabs (C/T/L/S/Cd) with multi-select chip grid for precise vertebral notation
|
||||
- **Detail popups** — click a zone (e.g. head) to open a secondary SVG with finer-grained zones
|
||||
- **PDF export** — A4 portrait with rasterized anatomy SVGs (canvg @ 2×), structured observations, and the full report JSON as a native PDF attachment
|
||||
- **PDF export** — A4 portrait with rasterized anatomy SVGs (native browser `Image`/`canvas` pipeline), structured observations, and the full report JSON as a native PDF attachment
|
||||
- **PDF re-import** — open a previously exported PDF to restore the session for a follow-up
|
||||
- **Bilingual UI** — full FR/EN interface with a one-click language switcher; default locale auto-detected from the browser, then persisted
|
||||
- **Configurable identity** — site name, brand, footer, tagline all come from env vars; nothing hardcoded
|
||||
@@ -46,7 +46,6 @@ contract.
|
||||
- Zustand 5 (state)
|
||||
- Zod 3 (schema + runtime validation)
|
||||
- pdf-lib 1.17 (PDF generation + native attachments)
|
||||
- canvg 4 (SVG → canvas rasterization)
|
||||
- motion 11 (animations)
|
||||
- vitest 3 + happy-dom + @testing-library/react
|
||||
|
||||
|
||||
Reference in new issue
Block a user