ruumica documentation

Install ruumica on a server

Set up a Debian 13 server with ruumica, its database and its coordinate grids, and prove that it works.

At the end of this page you have a Debian 13 server on which ruumica checks, converts and exports exactly as specified, and a test run that proves it.

Before you start

  • A Debian 13 machine (a virtual machine is fine) with about 20 GB of free disk space.
  • A user account that may run sudo without a password prompt (the installer uses sudo -n).
  • Internet access for the installation. ruumica itself never downloads anything while it works.
  • A copy of the ruumica repository on that machine. All commands below run in its top folder.

Steps

  1. Run the installer. It installs the system packages, the pinned Rust toolchain, PostgreSQL 17 with PostGIS, the coordinate grids, the PDF tool and the web toolchain. It is safe to run again: on an installed machine it changes nothing.

    $ scripts/bootstrap-debian13.sh
    …
    BOOTSTRAP OK
    
  2. Set the environment variables the installer prints at the end, in your shell and in your shell profile. They name the database and keep the coordinate library offline:

    export DATABASE_URL="postgres://<user>@localhost/asbuilt_test?host=/var/run/postgresql" PROJ_NETWORK=OFF
    export PATH="$HOME/.cargo/bin:$PATH"
    
  3. Build the program and put it on your path:

    $ cargo build --locked -p asbuilt
    …
    $ export PATH="$PWD/target/debug:$PATH"
    
  4. Create the database tables:

    $ asbuilt db migrate
    …
    
  5. Run the full self-test. It checks the database rules, proves every coordinate pipeline against official test points, judges the OTDR test files and exports the demo project twice, comparing the results byte for byte. It takes several minutes.

    $ scripts/verify-m2.sh
    …
    M2 FOUNDATION OK (WAIVER: ee-geoid, ee-authority)
    

Check

The last line of the self-test is M2 FOUNDATION OK. The words in brackets name the inputs that are still missing on purpose:

Estonian heights are not available yet. The licensed EST-GEOID2017 geoid model is not installed. Until it is, Estonian exports need --allow-grid-absent 'ee.*' and record that in the package, and field heights for Estonian projects wait with GRID_ABSENT. Norwegian projects are not affected.

Estonian drawings are provisional. The only Estonian export profile, ee.default.v1, has not been checked against an authority’s specification. Exports with it need --allow-unverified-profile, and every file is marked PROFILE NOT AUTHORITY-VERIFIED.

With ASBUILT_STRICT=1, the self-test allows no missing input and fails, naming each one.

What can go wrong

You see Meaning Do
sudo: a password is required The installer cannot use sudo without a prompt. Allow it for this user, or run the installer as root.
FAIL in the coordinate checks A pipeline does not reach its official test points on this machine. Do not deliver from this machine. Check that the grids were installed and that PROJ_NETWORK=OFF is set.
CRS_GRID_MISMATCH An installed grid file differs from the registered one. Run the installer again; it installs the registered files.
PDF_TOOL_MISSING or GPKG_TOOL_MISSING A tool the export needs is missing. Run the installer again.

Next

Last changed 2026-11-14