🖥️Detailed Start

This document explains how to install and use the AISdb web application components, providing instructions on running these services independently for testing or integration into an existing setup.

The application has three primary components:

• Database server (Back end web API)

• Database storage (Postgres database)

• Web application interface (JS front end)

And some secondary components:

• Documentation webserver

• AIS receiver client

• AIS livestream proxy dispatcher

Dependencies

The following software is requisite for each AISDB service:

• Database Storage

  • Postgresql Database Server

  • Postgresql Database Client Libraries

  • See the Postgres Install Tutorial

• Database Server

  • Rustup, the Rust Compiler Toolchain Install Rust

  • OpenSSL

• Web Application Front End

  • Rustup, the Rust Compiler Toolchain Install Rust

  • Binaryen, the WebAssembly Compiler Toolchain Binaryen

  • Wasm-pack, the Rust WebAssembly Packaging Utility Install wasm-pack

  • Clang, the C/C++ Compiler Clang Download

  • OpenSSL Development Toolkit (e.g. libssl-dev on ubuntu/debian)

  • Pkg-config pkg-config

  • NodeJS, the JavaScript Runtime Environment Node.js download

• Documentation Server

  • Python Download Python

  • Rustup, the Rust Compiler Toolchain Install Rust

  • Sphinx Doc Installing and Running Sphinx

  • Maturin Build System Maturin User Guide

  • NodeJS, the JavaScript Runtime Environment Node.js download

• AIS Receiver Client

  • Rustup, the Rust Compiler Toolchain Install Rust

• AIS Proxy Dispatcher

  • Rustup, the Rust Compiler Toolchain Install Rust

Database Storage

Ensure that the Postgres server is running by following the Postgres Database Server Tutorial. The other web services will use this server for storage and retrieval of AIS data.

Database Server

Configure the database server by setting the following environment variables for the postgres database connection:

PGPASSFILE=$HOME/.pgpass
PGUSER="postgres"
PGHOST="[fc00::9]"
PGPORT="5432"

Navigate to the database_server folder in the project repository, install it with cargo, and then run it.

cd database_server
cargo install --path .
aisdb-db-server