INSTALLATION GUIDE
Fararoni Suite — Installation on macOS, Windows and Linux
Complete guide to install the Fararoni ecosystem on the three major operating systems.
macOS (DMG)
File: Fararoni-Installer.dmg
Opening the DMG shows 3 elements:
| Element | Description |
|---|---|
| Fararoni Suite/ | Folder with the complete bundle (core + 4 sidecars + config) |
| Install Fararoni.command | Double-click to run the installation wizard |
| Applications | Symlink — drag "Fararoni Suite" here to install in /Applications |
Steps
- Open
Fararoni-Installer.dmg - Option A: Double-click "Install Fararoni.command" (interactive wizard)
- Option B: Drag "Fararoni Suite" to Applications (manual install)
- Configure credentials in
~/.fararoni/config/
Fararoni Suite/ Contents
bin/
fararoni-core # Core Java (GraalVM native or JAR wrapper)
fararoni.sh # Startup script
sidecar-telegram # Sidecar Telegram (SEA binary)
sidecar-whatsapp # Sidecar WhatsApp (SEA binary)
sidecar-discord # Sidecar Discord (SEA binary)
sidecar-imessage # Sidecar iMessage (SEA binary)
lib/
fararoni-gateway-rest-1.0.0.jar
fararoni-enterprise-transport-1.0.0.jar
fararoni-launcher.sh # Orchestrator: starts core + sidecars
installer.sh # Installation wizard (macOS/Linux)
global.env # Global environment variables
LICENSE # Apache 2.0Windows (ZIP)
File: fararoni-v1.0.0.zip
Steps
- Extract
fararoni-v1.0.0.zip - Double-click "Install Fararoni.bat" (PowerShell wizard)
- Or run manually:
powershell -File installer.ps1 - Configure credentials in
%USERPROFILE%\.fararoni\config\
Linux (TAR.GZ)
File: fararoni-v1.0.0.tar.gz
Steps
tar xzf fararoni-v1.0.0.tar.gzcd fararoni-v1.0.0 && chmod +x installer.sh && ./installer.sh- Configure credentials in
~/.fararoni/config/ - Sidecars are registered as systemd services
Cross-Platform Generation (CI/CD)
To generate native installers on all 3 platforms, a CI pipeline is used:
GitHub Actions Matrix:
- macos-latest (arm64) → DMG + ZIP
- ubuntu-latest (x64) → TAR.GZ + .deb (optional)
- windows-latest (x64) → ZIP + MSI (optional)Each platform runs:
./build-sidecars.sh→ generates native SEA binaries for that OSmvn package→ packages into ZIP/TAR.GZ- macOS:
./create-dmg.sh→ generates DMG - Linux:
dpkg-deborrpmbuild(optional) - Windows: WiX Toolset or Inno Setup (optional)
SEA sidecars are platform-specific because they embed the Node.js binary from the OS where they are compiled.
Source code
Full guide available in the repository:
github.com/ebercruzf/fararoni-ecosystem — INSTALL-GUIDE.md