doxa-maps/documentation/DEPLOY.md

Deploying dx-maps — the 4 ways it ships

dx-maps is one repo that runs in four places. Two are for building maps (your laptop, a shared cloud dev server); two are for showing them (public embeds, a folder inside your own site). The building ones run the live source with hot reload; the showing ones serve the built folder, dx-maps/, which is checked for private files before it is published.

#	Where	For	What you run	What you get
1	Your laptop	building, alone or with a team	bun run dev	the Plugin Studio at http://localhost:5173
2	A shared cloud dev server	a team, or an agent on a server	the Docker image in deployment/cloud/	the Plugin Studio at https://<your-host>/, behind your team's sign-in
3	Public embeds	other sites showing a map	the built dx-maps/ folder on /cdn or any static host	https://<host>/…/dx-maps/<plugin>/<profile>/index.html and …/<plugin>/<plugin>.js
4	Inside your own site	one site hosting every map	copy dx-maps/ into the site's public/	the maps at https://<your-site>/<folder>/…

---

1. Your laptop — bun run dev

git clone --depth 1 https://git.nuxtbase.app/doxa-open/doxa-maps.git
cd doxa-maps
bun install --frozen-lockfile
bun run dev          # → http://localhost:5173/  is the Plugin Studio

Zero config: no .env is needed. Everything is local by default — hot reload of your own edits, a local PocketBase at /api/pb, and Rudder's voice engine once it is set up (Go 1.22+, then bash backend/rudder-engine/setup-runtime.sh). Every setting, with its default, is in .env.example; an empty value means the default.

• Follow what teammates land on a shared branch: set DX_SYNC_REMOTE (a remote name or a repo URL).
• Use the team's shared PocketBase instead of a local one: set DX_PB_URL.

Details: HOWTO-join-the-table.md.

2. A shared cloud dev server — Docker or Coolify, with /data

One running copy of the Plugin Studio that follows a branch and hot-reloads every push, for a whole team or for an agent that lives on a server. Nobody edits files on it: changes arrive by pushing. It follows development, the branch the team lands on, and publishes main (production) at /cdn (way 3).

docker build -t dx-maps-dev .
docker run -d -p 5173:5173 -v dx-maps-data:/data \
  -e REPO_URL=https://<host>/<owner>/<repo>.git -e BRANCH=development -e PRODUCTION_BRANCH=main dx-maps-dev

Or docker compose up -d --build with the root compose.yaml, or point a container host at the repo: it finds the root Dockerfile (the platforms are in deployment/cloud/README.md). Give it a domain.

• Give it a persistent /data volume. It holds the team PocketBase (dev and prod) and the last published build. Without one, every restart or redeploy starts empty.
• Put the sign-in in front before it is reachable from the internet: the OIDC_* settings. Only the groups you allow get in.
• About 2.5 GB of memory and 2 vCPUs.

It also serves the team PocketBase at /pb/ and, after an admin triggers a build, the public embed folder at /cdn/ (way 3).

Details: deployment/cloud/README.md and CLOUD-DEVELOPMENT-ENVIRONMENT.md.

3. Public embeds — /cdn or any static host

The built folder, dx-maps/, is what other sites embed. Every link inside it is relative, so it works from any address.

• From the cloud dev server: /cdn/ serves main, which is production (PRODUCTION_BRANCH=main; the container's default is a branch named production). development is the shared table where everyone lands all day; main moves only when a maintainer publishes. The container notices when main moves and rebuilds /cdn by itself (about 2 minutes after the move, then about 2 minutes to build). Each build removes private files, refuses to publish if any remain, keeps the last good build if anything fails, and swaps /cdn/dx-maps/ over atomically. /cdn/ is public (no sign-in) and sends Access-Control-Allow-Origin: *, so both iframes and JS embeds work on other sites. The manifest, the pages and each map's script revalidate after 5 minutes (with an ETag), so browsers pick up a publish within minutes.

  To publish (merge development into main), once the checks pass on the commit you want public:

  git fetch origin && git switch main && git merge --ff-only origin/main
  git merge --ff-only origin/development   # everything the team landed, as checked
  bun run gates:pre                        # the checks must pass on exactly this commit
  git push origin main                     # /cdn follows within a few minutes
  

  An admin can also rebuild at once (POST /admin/build), and /admin/status shows what /cdn serves and what main points at.

  Copy-paste snippets are relative unless the build is given an absolute base: EMBED_BASE_URL=https://<host>/<path> (the address the dx-maps/ folder is served under, without dx-maps) makes every snippet absolute, so it works when pasted on another site.

• On any static host: build locally with BUILD_ALLOW=1 bun run build and upload public/dx-maps/. For JS embeds on other sites, the host must send Access-Control-Allow-Origin: *.

Every page loads its script with an integrity hash, so a tampered or stale script is refused by the browser. The Plugin Studio's "copy embed" gives you the iframe and the script snippet for each map.

Details, per host (Cloudflare Pages, jsDelivr, any web server) and per embed style: README — What the build makes and README-SECTION-3-cli-commands.md.

4. Inside your own site — the folder in public/

Copy the built dx-maps/ folder into your site's public/ (renaming it is fine) and your site becomes the host: no second server and no cross-site setup, because the maps and the page share one origin.

Live example: the DX-life branch research-gallery-drop-in drops the folder into DX-life's public/ and fills /research with the Research Gallery. Run it with bun install && bun run dev, then open /research/.

All three ways a site can take the maps, on your laptop: DX-life has one branch per way: research-gallery-drop-in (this section), research-gallery-cdn (way 3, loading from a dx-maps server) and research-gallery-subdomain (the Research Gallery on its own address). The exact commands to run each against your local dx-maps (ports, the one or two settings, and what to check) are in LAPTOP-6WAY.md.

---

Which one? Building maps: 1, plus 2 if several people or agents work together. Showing maps on other sites: 3. Showing them on a site you already run: 4.