# Installation Guide

The following requirements and instructions are valid in macOS, similar to Linux, and have not been tested on Windows yet.

## Build from Source

The source code of OlaOS will be open source soon!

### Requirements

#### Rust

Install the latest version of [Rust](https://www.rust-lang.org/)

```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

#### Docker

OlsOS's database runs in a Docker container, so Docker is required.

Install the latest version of [Docker](https://www.docker.com/), it is recommended to install Docker desktop app.

#### Postgres

The underlying database of OlaOS uses Postgres, installation instruction on macOS

```
brew install postgresql@15
```

#### SQLx CLI

Database connection and migration use [sqlx-cli](https://github.com/launchbadge/sqlx/tree/main/sqlx-cli)

```
cargo install sqlx-cli
```

### Installation

## Installation from pre-built Binary

Coming soon!
