Choose where to run Marfa

Choose between your own Mac or Linux computer, Railway and a server, and what the disk and memory of each must hold.

An instance is one server with one database and one folder of files, and it needs little while it waits. Run it where it can stay on, with a disk that holds your files.

WhereChoose it whenSteps
Your own Mac or Linux computerIt stays on, and you reach it from your own devicesInstall on a Mac or Linux
RailwayYou want an https address and no computer to look afterRun on Railway
A server or container platformYou already run one, or use your own supervisorRun in a container

What a host needs

  • A 64-bit computer Marfa runs on: a Mac with Apple silicon, or Linux on x86_64 or arm64. There's no build for an Intel Mac or Windows.
  • One server for the database. Keep a host at one replica, and turn off anything that stops an idle service: the server runs its health jobs and backups in the background.
  • Disk for the database and every file. Each file's bytes are kept once, beside the database.
  • Memory for the largest file it reads. The server reads the text of each file you save, and one file may use up to 1 GiB while it does. On a host with less to spare, lower enrichment_max_memory_bytes: a file that needs more is skipped and keeps no text.

Leave room on the disk

The server keeps 128 MiB free on the volume of its data, set by disk_reserve_bytes. A save, a restore or an export that would take the volume below it is refused with 507 insufficient_storage, and the instance goes on answering reads. marfa attention names the disk as degraded once less than the reserve, or 64 MiB if that is more, is free.

Leave more room than the reserve for what the server writes beside your data:

  • An archive export writes temporary files on the same volume while it runs, and the reserve counts them.
  • A backup folder on the same volume holds its own copy of every file, so put it on another disk.
  • An upgrade keeps a copy of the database beside it, as marfa.db.before-upgrade.

Check an instance's health shows what an instance uses now. Instance settings lists every setting named here.

On this page