Choose your platform
LocallyCloud is a Linux program. It is developed natively on Arch Linux and distributed as an Arch package and as one .deb for Debian, Ubuntu LTS, and their derivatives, including WSL 2. On macOS and on Windows without WSL, run it inside a Linux virtual machine and use it from the host through a forwarded port.
| Level | Platform | Architectures | How to install |
|---|---|---|---|
| Tier 1 | Arch Linux (current) | x86_64 | Arch package (pacman -U) or build from source |
| Tier 2 | Debian 13 | amd64, arm64 | .deb with apt |
| Tier 2 | Ubuntu 24.04 LTS and 26.04 LTS | amd64, arm64 | .deb with apt |
| Tier 2 | Distributions based on the releases above (Linux Mint, Pop!_OS, elementary OS, …) | amd64, arm64 | .deb with apt |
| Tier 2 | Windows 10/11 with WSL 2 running one of the releases above | amd64, arm64 | .deb with apt inside WSL |
| Best effort | Arch Linux ARM | aarch64 | makepkg with packaging/arch/PKGBUILD |
Debian and Ubuntu · .deb
The .deb supports Debian 13, Ubuntu 24.04 LTS and 26.04 LTS, distributions based on them (such as Linux Mint or Pop!_OS), and WSL 2 distributions based on them. Releases provide one package per architecture: amd64 for Intel and AMD processors, and arm64 for ARM processors. The package requires glibc 2.39 or later; older releases such as Ubuntu 22.04 are not supported, and apt refuses to install the package there. When a tagged release is available, download the .deb for your architecture (dpkg --print-architecture shows it). From the download directory:
Choose the command for your architecture; check it with dpkg --print-architecture.
amd64
sudo apt install ./locallycloud_0.1.0~beta.1-1_amd64.debarm64
sudo apt install ./locallycloud_0.1.0~beta.1-1_arm64.debUse the filename for the version and architecture you downloaded. The package includes SQLite and installs its required system libraries through apt, plus the recommended dbus-user-session; Rust and a separate SQLite installation are not needed. The installed command is locallycloud.
Arch Linux · x86_64
When a tagged release is available, download its .pkg.tar.zst for Arch Linux x86_64:
sudo pacman -U ./locallycloud-0.1.0beta.1-1-x86_64.pkg.tar.zstUse the filename for the version you downloaded. The package requires SQLite 3.53.4 or later from the Arch repositories. The installed command is locallycloud.
Arch Linux ARM · aarch64
On Arch Linux ARM (aarch64), build the package from a source checkout with makepkg in packaging/arch; that platform is supported on a best-effort basis.
cd packaging/arch
makepkg -siPackage releases ↗ · Full package instructions ↗
Build from source
From the repository root, with these dependencies installed:
- Rust 1.95.0 or later, including Cargo.
- SQLite 3.53.4 or later, including development headers and the library.
- A C/C++ build toolchain, CMake, and pkg-config for native dependencies.
- OpenSSL CLI for the key-generation example below.
- AWS CLI v2 for the usage examples, or an AWS SDK for your application.
cargo build --release --locked -p locallycloudThe executable is target/release/locallycloud. Continue with Quick start.
After preparing the master key below, start the source build:
./target/release/locallycloudKeep one key for your local data
Generate a base64-encoded 32-byte KMS master key once, before the first startup:
Keep this key securely and reuse it for the same state directory after restarting. An unencoded 32-character string is not valid; changing the key prevents reading data encrypted with the previous key.
export LOCALLYCLOUD_KMS_MASTER_KEY="$(openssl rand -base64 32)"Start and check your endpoint
locallycloudIn another terminal:
curl -fsS http://127.0.0.1:4566/_locallycloud/healthThe default AWS endpoint is http://127.0.0.1:4566. Open the dashboard at http://127.0.0.1:4566/_locallycloud/ui, or inspect registered services at http://127.0.0.1:4566/_locallycloud/status.
Run LocallyCloud as your regular user. Compute and database workflows need additional host tools.
Runtime requirements ↗