Skip to content

Latest commit

聽

History

History
35 lines (29 loc) 路 1.61 KB

INSTALL.md

File metadata and controls

35 lines (29 loc) 路 1.61 KB
Raw

Airup Installation Guide

This guide describes how to build, configure and install Airup.

Build Dependencies

To build Airup, you need to install the few dependencies first:

  • Rust: The programming language used to implement Airup.

Airup requires Rust 1.75.0 or newer to compile.

Configuration

Some Airup functions are configured at build time. The build manifest which is located at build_manifest.json stores primitive paths that cannot be set at runtime or default values of system.conf items. An example file is located at docs/resources/build_manifest.json. There is a list that describes all available configuration items:

  • os_name: Name of the OS build.
  • config_dir: Path of Airup's configuration directory, which stores service/system config files, etc.
  • service_dir: Path of Airup's service directory, which stores service files.
  • milestone_dir: Path of Airup's milestone directory, which stores milestone files.
  • runtime_dir: Path of Airup's runtime directory, which stores runtime files like the Unix sockets, locks, etc.
  • log_dir: Path of Airup's logging directory, which stores files generated by the Airup logger.
  • env_vars: Environment variables for the global system. When a value is explictly set to null, the variables is deleted if it exists.
  • early_cmds: Commands that are executed in the early_boot pseudo-milestone.

Build

To build debug version of Airup, run:

cargo build

To build release version of Airup, run:

cargo build --release

Install

Read the documents to learn more about installation.