Skip to content
MetaxisData
中文

Getting started

Run MetaxisData from the container image or a prebuilt binary, create the first account, and sync an instance.

You need Docker and a PostgreSQL database the container can reach. Images are published to GHCR for linux/amd64 and linux/arm64:

Terminal window
docker run -d --name metaxisdata \
  -p 8083:8083 \
  -e PG_URL='postgres://user:password@db-host:5432/metaxisdata?sslmode=disable' \
  ghcr.io/ranxy/metaxisdata:latest

Without Docker at hand, every release also publishes the same server as static binaries for five platforms — download one from GitHub Releases and run it directly; the deploy guide’s Get the server section shows how.

Open http://<host>:8083 and:

  1. Create the first account. It becomes the workspace administrator.
  2. Add an instance and sync its schema.

Optional next steps:

  • Close self-service signup. Turn on Disallow self-service signup in Settings → General, so only administrators can create users.
  • Serve HTTPS. The container serves plain HTTP by design. Terminate HTTPS in a reverse proxy in front of it, and set METAXISDATA_TRUSTED_PROXIES to the proxy’s address so the audit log records clients instead of the proxy.
  • Protect stored credentials. Set METAXISDATA_ENCRYPTION_KEY so a database dump alone cannot decrypt the credentials stored for your instances — and keep that key safe: losing it leaves the stored credentials unreadable.
  • Connect MCP clients. Enable the MCP endpoint in Settings → General — it requires the workspace external URL — then follow docs/mcp.md.

The complete deployment guide — every environment variable, the health and version endpoints, the prebuilt binary, and building the image or the binary yourself — is docs/deploy.md.

docker-compose.yml starts PostgreSQL and the server together, so one command is enough to look at a built image on your own machine:

Terminal window
make docker-up      # build the image, then start PostgreSQL + the server on http://localhost:8083
make docker-down    # stop both; the compose data volume is kept

Open http://localhost:8083 and create the first account. The stack makes taking a build for a spin easy — published port, hardcoded development password — and is not meant for production. Details and caveats are in docs/local-trial.md.