Files
logos-docs/docs/basecamp/get-started/install-logos-basecamp.md

3.1 KiB

title, doc_type, product, topics, steps_layout, authors, owner, doc_version, slug, sidebar_position
title doc_type product topics steps_layout authors owner doc_version slug sidebar_position
Install Logos Basecamp procedure core core flat iurimatias, cheny0 logos 1 install-logos-basecamp 1

Install Logos Basecamp

Get Logos Basecamp running on your desktop.

Logos Basecamp is the desktop shell for Logos. You can discover, install, and run Logos modules and apps using its graphical interface as an alternative to the command line.

You can install Logos Basecamp in two ways:

Method When to use it Tooling required
Prebuilt release (AppImage or DMG) End users None
Build from source with Nix Contributors, custom builds, unsupported platforms Nix with flakes enabled

:::info To enable flakes in nix, add experimental-features = nix-command flakes to /etc/nix/nix.conf. :::

Before you start, make sure you have the following:

  • Internet access.
  • A supported OS: Linux x86_64 or aarch64 (tested on Ubuntu 22.04+), or macOS aarch64 (recent versions).
  • 4 GB RAM minimum (8 GB recommended) and ~2 GB free disk space.
  • For the source build only: Nix installed with flakes enabled.

:::info Internet access is required to download the binary or clone the repository, but not to launch Logos Basecamp afterward. Logos Basecamp itself opens no inbound ports. :::

Install from a prebuilt release

  1. Go to the latest release page and download the artifact for your OS:

    • Linux: the AppImage files
    • macOS: the .dmg files
  2. Depending on your OS, install and launch Basecamp as follows:

  • On macOS, drag the .dmg file into /Applications. Then launch Basecamp from /Applications.

  • On Linux, grant execute permission to the downloaded AppImage and launch it:

    chmod +x LogosBasecamp-Desktop-*.AppImage
    ./LogosBasecamp-Desktop-x86_64.AppImage  # or logos-basecamp-aarch64.AppImage
    

Build and run Logos Basecamp from source

  1. Clone the repository and enter it:

    git clone https://github.com/logos-co/logos-basecamp.git
    cd logos-basecamp
    
  2. Build Basecamp with Nix flake:

    nix build '.#bin-appimage'
    
  3. Run the resulting binary:

    ./result/logos-basecamp.AppImage
    

Troubleshooting Basecamp

Experimental Nix feature 'nix-command' when building the AppImage

The following error might appear while building the AppImage:

error: experimental Nix feature 'nix-command' is disabled; add '--extra-experimental-features nix-command' to enable it

in which case the command should be changed to enable flakes:

nix build --extra-experimental-features 'nix-command flakes' '.#bin-appimage'

I see an libEGL.so.1 / libOpenGL.so.0 missing error when trying to launch the AppImage on Linux?

Try running the following command:

sudo apt-get install -y fuse libegl1 libopengl0