Requirements
System requirements to run Portabase.
To run Portabase, you need the following installed on your system:
1. Docker & Docker Compose
Portabase runs as a set of Docker containers. You must have Docker Engine (version 20.10+) and Docker Compose (version 2.0+) installed.
Ubuntu / Debian / Fedora
The easiest way to install Docker on Linux is using the official convenience script:
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.shPost-installation steps:
To run Docker without sudo, add your user to the docker group:
sudo usermod -aG docker $USERYou may need to log out and back in for this change to take effect.
Docker Desktop
For macOS, the recommended way is to install Docker Desktop. It includes Docker Engine, Docker CLI, and Docker Compose.
- Download the installer from the Official Docker Website.
- Drag and drop Docker into your Applications folder.
- Launch Docker from your Applications.
2. Operating System
- Linux: Any modern distribution (Ubuntu 22.04+, Debian 11+, CentOS, etc.).
- macOS: Catalina 10.15 or newer.
3. Network Requirements
- Local Port: By default, the dashboard uses port
8887. Ensure it is not being used by another service. - Internet Access: Required to pull Docker images and for the agent to communicate with the dashboard (if hosted remotely).
You can check if Docker is correctly installed by running docker compose version in your terminal.
4. Development Requirements (Optional)
If you plan to contribute to Portabase or build it from source, you will need the following tools:
Agent (Rust)
The agent is built with Rust for performance and safety.
- Rust: Version 1.75+ (latest stable recommended).
- Package manager:
cargo, included with the Rust toolchain.
CLI (Python)
The CLI is written in Python with Typer.
- Python: Version 3.12+.
- Package manager:
uv
Dashboard (TypeScript)
The dashboard is a modern web application built with Next.js and React.
- Node.js: Version 20+.
- Package manager:
pnpmVersion 9+.