Files
paper-doc/backend/.env.example
T
govin 6f37120dc4 backend: keep a figure in the object store, and serve it back by key
A paper needs its experiment figures, and a figure is not text: the bytes go to
MinIO and the sentence keeps a Markdown address. That is what keeps a sentence
one editable string — a picture moves between paragraphs by being cut and
pasted, and survives a template switch with the sentence it belongs to.

Three decisions carry the safety, and each is a way to serve something other
than what was uploaded:

* the key is the digest of the bytes, so uploading the same screenshot twice is
  one object and the address can never come to mean a different picture — which
  is what makes the year-long `immutable` cache header safe;
* the format is sniffed from the magic bytes, not read from the client's
  `Content-Type` or filename, and SVG is refused because an uploaded SVG served
  from this origin is stored XSS;
* serving is restricted to the key space this application writes, so
  `GET /api/images/{key}` cannot become a browser for the rest of the bucket.

Images are served through the API rather than from a public bucket URL so a
sentence never embeds a host name — the LAN in development and the public
address later would otherwise disagree — and the bucket can stay private. The
object is streamed rather than read into memory, and the connection is released
when the reader stops.

Storage unconfigured is a 503 that names the missing variables, not a crash:
the writing path does not depend on the bucket.

`scripts/smoke_images.py` walks the whole thing: each accepted format, the
refusals (text, SVG, a mislabelled file, an empty file, a key we did not
write), and a sentence that carries a figure through the paper endpoints.
2026-09-23 13:31:27 +08:00

35 lines
1.3 KiB
Bash

# Copy to .env and fill in real values. .env is git-ignored.
# --- Application ---
APP_NAME=paper-doc API
DEBUG=true
# --- Database (TiDB) ---
# Local development reaches TiDB through its k3s NodePort.
# Inside the cluster, use the Service instead: DB_HOST=tidb-tidb.tidb, DB_PORT=4000
DB_HOST=192.168.1.88
DB_PORT=32738
DB_USER=Govin
DB_PASSWORD=change-me
DB_NAME=paper_doc
# Optional: bypass the DB_* parts above with a full SQLAlchemy URL.
# The password must be percent-encoded (a raw '@' would be parsed as the
# user/host separator). Prefer the DB_* parts above and let the app encode it.
# DATABASE_URL=mysql+pymysql://Govin:change-me%40123@192.168.1.88:32738/paper_doc
# --- Object storage (MinIO) — where the images a paper embeds are kept ---
# Leave these empty and the paper still writes and reads; only the image
# endpoints answer 503, saying exactly which variables are missing.
# The bucket is created on the first upload if it does not exist yet, so a
# dedicated access key with read/write on that one bucket is enough.
# Inside the cluster, use the Service: http://minio.minio.svc.cluster.local:9000
MINIO_ENDPOINT=http://192.168.1.88:30090
MINIO_ACCESS_KEY=change-me
MINIO_SECRET_KEY=change-me
MINIO_BUCKET=paper-images
MINIO_REGION=us-east-1
# Largest image accepted, in bytes (default 20 MiB).
# MAX_IMAGE_BYTES=20971520