Skip to content
Klutch.sh Docs

Deploying a Mapzy App

Introduction

Mapzy is an open-source mapping and geospatial visualization tool built on Node.js. Deploying Mapzy with a Dockerfile on Klutch.sh provides reproducible builds, managed secrets, and persistent storage for tiles and uploads—all managed from klutch.sh/app. This guide covers installation, repository prep, a production-ready Dockerfile, deployment steps, Nixpacks overrides, sample API usage, and production tips.

Prerequisites

  • A Klutch.sh account (create one)
  • A GitHub repository containing your Mapzy code/config (GitHub is the only supported git source)
  • Docker familiarity and Node.js 18+ knowledge
  • Database credentials if Mapzy stores metadata externally (PostgreSQL recommended)
  • Storage for tiles, uploads, and logs

For onboarding, see the Quick Start.

Architecture and ports

  • Mapzy serves HTTP; set the internal container port to 3000.
  • If you use PostgreSQL or Redis, deploy them as separate Klutch.sh TCP apps exposed on port 8000 and connect on native ports (5432/6379).
  • Persistent storage is recommended for tile cache/uploads and logs.

Repository layout

mapzy/
├── Dockerfile              # Must be at repo root for auto-detection
├── package.json
├── pnpm-lock.yaml          # or yarn.lock / package-lock.json
├── .env.example            # Template only; no secrets
├── public/                 # Static assets
├── uploads/                # Tiles/uploads (mount as volume)
└── README.md

Keep secrets out of Git; store them in Klutch.sh environment variables.

Installation (local) and starter commands

Install dependencies and run locally before pushing to GitHub:

Terminal window
pnpm install
pnpm build
pnpm start -- --port 3000

Optional helper start.sh for portability and Nixpacks fallback:

#!/usr/bin/env bash
set -euo pipefail
exec pnpm start -- --port 3000

Make it executable with chmod +x start.sh.

Dockerfile for Mapzy (production-ready)

Place this Dockerfile at the repo root; Klutch.sh auto-detects it (no Docker selection in the UI):

FROM node:18-alpine AS build
WORKDIR /app


COPY package.json pnpm-lock.yaml* yarn.lock* package-lock.json* ./
RUN corepack enable
RUN pnpm install --frozen-lockfile


COPY . .
RUN pnpm build


FROM node:18-alpine
WORKDIR /app
ENV NODE_ENV=production PORT=3000


COPY --from=build /app /app
RUN corepack enable && pnpm install --prod --frozen-lockfile


EXPOSE 3000
CMD ["pnpm", "start", "--", "--port", "3000"]

Notes:

  • Add build tools (apk add --no-cache python3 make g++) in the build stage if native modules are needed.
  • Keep uploads/ writable and mount it as a volume for tiles and user uploads.

Environment variables (Klutch.sh)

Set these in the Klutch.sh app settings (Secrets tab) before deploying:

  • NODE_ENV=production
  • PORT=3000
  • APP_BASE_URL=https://example-app.klutch.sh
  • DATABASE_URL=postgres://<user>:<password>@<host>:<port>/<db> (if using a database)
  • MAPZY_UPLOAD_DIR=/app/uploads
  • Any provider/API keys your Mapzy deployment uses (e.g., map tile providers)

If you deploy without the Dockerfile and need Nixpacks overrides:

  • NIXPACKS_BUILD_CMD=pnpm install --frozen-lockfile && pnpm build
  • NIXPACKS_START_CMD=pnpm start -- --port 3000
  • NIXPACKS_NODE_VERSION=18

These keep Mapzy compatible with Nixpacks defaults when a Dockerfile is absent.

Attach persistent volumes

In Klutch.sh storage settings, add mount paths and sizes (no names required):

  • /app/uploads — for tiles, user uploads, and cached assets.
  • /app/logs — optional if you store logs locally.

Ensure these paths are writable inside the container.

Deploy Mapzy on Klutch.sh (Dockerfile workflow)

  1. Push your repository (with the Dockerfile at the root) to GitHub.
  2. Open klutch.sh/app, create a project, and add an app.
  1. Connect the GitHub repository; Klutch.sh automatically detects the Dockerfile.
  2. Choose HTTP traffic for Mapzy.
  3. Set the internal port to 3000.
  4. Add the environment variables above (database URL if used, app URL, upload dir, provider keys, and any NIXPACKS_* overrides if you temporarily deploy without the Dockerfile).
  5. Attach persistent volumes for /app/uploads (and /app/logs if used), selecting sizes that fit your storage needs.
  6. Deploy. Your Mapzy instance will be reachable at https://example-app.klutch.sh; attach a custom domain if desired.

Sample API usage

Fetch a list of maps (example endpoint; adjust to your API):

Terminal window
curl -X GET "https://example-app.klutch.sh/api/maps" \
  -H "Authorization: Bearer <token>"

Health checks and production tips

  • Add a reverse proxy probe to / or a lightweight status route.
  • Enforce HTTPS at the edge; forward HTTP to port 3000 internally.
  • Keep lockfiles committed and Node version pinned; test upgrades before applying.
  • Monitor storage usage on /app/uploads and resize before it fills.
  • Secure provider/API keys in Klutch.sh secrets and rotate them regularly.
  • Tune caching/asset settings for performance based on your map traffic.

Mapzy on Klutch.sh combines reproducible Docker builds with managed secrets, persistent storage for tiles and assets, and flexible HTTP/TCP routing. With the Dockerfile at the repo root and port 3000 configured, you can deliver reliable mapping experiences without extra YAML or workflow overhead.