building-on-linux.md

🐧 Building on Linux

Notes:

• The following steps are verified on
  • Lubuntu 20.04 - x86_64
  • Linux Mint 20.3 - x86_64
  • Ubuntu 20.04 - aarch64
  • Ubuntu 22.04 - x86_64
  • Redhat Linux - x86_64
  • Fedora 37 - x86_64
  • Arch Linux - x86_64
  • Deepin - x86_64
  • Raspberry Pi OS - aarch64
• You may need to disable hardware 3D acceleration if you are running AppFlowy in a VM. Otherwise, certain GL failures will prevent the app from launching.
• This guide assumes that you are using the bash shell on Linux. You can however, replicate these steps on zsh or other alternative Linux terminal shells, with minor alterations.

{% hint style="warning" %} If you encounter any issues, have a look at Troubleshooting first. If your issue is not included in the page, please create an issue or ask on Discord. {% endhint %}

{% hint style="danger" %} Attention: There is an issue affecting Ubuntu 22.04, Fedora 37, and PopOS 22.04:

Failed to load dynamic library 'libdart_ffi.so': libssl.so.1.1: cannot open shared object file: No such file or directory. The issue can be fixed by installing the required missing libraries:

For Fedora Workstation:

sudo dnf install openssl-devel

For Fedora Silverblue:

rpm-ostree upgrade
rpm-ostree install openssl1.1.x86_64

For Silverblue, it is necessary to perform both the upgrade and the installation.

For Ubuntu & PopOS:

1. Download the required package by executing the following command:

wget http://archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.0g-2ubuntu4_amd64.deb

2. Install the downloaded package using the following command:

sudo dpkg -i libssl1.1_1.1.0g-2ubuntu4_amd64.deb

If the provided link for Ubuntu & PopOS is expired or returns an error 404, you can search for "libssl1.1_1.1.1" on the page. {% endhint %}

Step 1: Get the source code

Clone the source code from our Github project.

git clone https://github.com/AppFlowy-IO/AppFlowy.git

{% hint style="warning" %} Ensure that git is installed in your system!! Use your package manager to install git if your distribution doesn't ship with git.

# Ubuntu
sudo apt install git

# Fedora
sudo dnf install git

# Arch
sudo pacman -S git

{% endhint %}

{% hint style="info" %} You should fork the code instead if you wish to submit code to AppFlowy. You will find information on that in Setting Up Your Repositories. {% endhint %}

Image: Cloning the source from the Github repository.

Step 2: Install your build environment

Install system prerequisites:

{% tabs %} {% tab title="Ubuntu" %}

sudo apt-get install curl build-essential libsqlite3-dev libssl-dev clang cmake ninja-build pkg-config libgtk-3-dev unzip libkeybinder-3.0-dev libnotify-dev

{% endtab %}

{% tab title="Fedora" %}

sudo dnf install sqlite-devel keybinder3-devel clang cmake ninja-build openssl-devel

{% endtab %}

{% tab title="Arch" %}

sudo pacman -S curl base-devel sqlite openssl clang cmake ninja pkg-config gtk3 unzip libkeybinder3 xdg-user-dirs

{% endtab %} {% endtabs %}

Image: Installing prerequisites on Ubuntu.

Install flutter (three different methods):

{% hint style="danger" %} Flutter version 3.19.0 is the recent supported stable release used for building AppFlowy. Building with the latest stable Flutter release is not tested and might throw errors while building. {% endhint %}

• Method 1: Install flutter according to https://docs.flutter.dev/get-started/install/linux. Make sure to install flutter in a directory that is appropriate for you.
• Method 2: You can use the code below to install flutter manually on your linux system.

git clone https://github.com/flutter/flutter.git --branch 3.19.0
cd flutter
echo -e "\nexport PATH=\$PATH:"`pwd`"/bin" >> ~/.bashrc
source ~/.bashrc
flutter
cd ..

Image: Installing flutter manually.

• Method 3: You can also use a runtime version manager like asdf or a flutter-specific version manager to install flutter on your system. Assuming you are using the bash shell, follow these steps:

1. Clone asdf.

git clone https://github.com/asdf-vm/asdf.git ~/.asdf --branch v0.11.1

2. Add the path to asdf and enable asdf auto-completion in your shell.

echo -e '\n# asdf configuration \n. "$HOME/.asdf/asdf.sh"\n. "$HOME/.asdf/completions/asdf.bash"' >> ~/.bashrc
source ~/.bashrc

{% hint style="warning" %} If you are not using bash, check the official asdf guide to learn how to set up asdf for your shell. {% endhint %}

3. Install flutter via asdf and set it as your local runtime at the AppFlowy source directory (xx/AppFlowy/).

cd AppFlowy
asdf plugin-add flutter
asdf install flutter 3.19.0-stable
rm -rf .tool-versions
asdf local flutter 3.19.0-stable
cd ..

{% hint style="warning" %} Some distributions might miss certain packages essential for asdf, such as jq, curl, or wget. Please make sure they are installed via your package manager.

👉 Ubuntu 22.04 does not come with the package jq installed by default, you will have to install by doing:

sudo apt install jq

{% endhint %}

Image: Installing flutter using asdf

Setting up your development environment:

Run the setup script from the base directory. (Note: You can skip this step if you installed rust using asdf and set it as the local runtime inside thexx/AppFlowy/ source.)

cd AppFlowy
./frontend/scripts/install_dev_env/install_linux.sh
source ~/.bashrc

Image: Running script install_linux.sh inside xx/AppFlowy/frontend/scripts/install_dev_env/.

{% hint style="warning" %} If you get this warning:

---

Warning: Pub installs executables into $HOME/.pub-cache/bin, which is not on your path. You can fix that by adding this to your shell's config file (.bashrc, .bash_profile, etc.):

export PATH="$PATH":"$HOME/.pub-cache/bin"

Then run the following command to add the path inside your shell configuration dotfile (.bashrc, .zshrc, etc.). For bash users:

echo -e '\nexport PATH="$PATH":"$HOME/.pub-cache/bin"' >> ~/.bashrc
source ~/.bashrc

OR, alternatively run this in your shell every time you build AppFlowy:

export PATH="$PATH":"$HOME/.pub-cache/bin

{% endhint %}

Image: "Warning: Pub installs executables into $HOME/.pub-cache/bin, which is not on your path."

Step 3: Build AppFlowy (Flutter GUI application)

Change your path to the frontend directory.

cd frontend

Building the AppFlowy binary:

{% tabs %} {% tab title="Release binary" %}

cargo make --profile production-linux-x86_64 appflowy

{% endtab %}

{% tab title="Debug binary" %}

cargo make --profile development-linux-x86_64 appflowy-dev

{% endtab %} {% endtabs %}

You will find the binary in frontend/appflowy_flutter/product/[version in x.x.x]/linux/[Binary type (Release/ Debug)]/AppFlowy/.

Image: Building AppFlowy

Step 4: Run the application

For running the release binary:

cd appflowy_flutter/product/[version number in x.x.x]/linux/Release/AppFlowy
./app_flowy

For running the debug binary:

cd appflowy_flutter/product/[version number in x.x.x]/linux/Debug/AppFlowy
./app_flowy

{% hint style="info" %} If you do not know the version number for the AppFlowy binary that you have built, please use your terminal shells' tab completion, or type and enter thels(list) command to reveal the name of folder which is the version number you are building.

The current version of AppFlowy is 0.1.0. {% endhint %}

A new window as shown below will show up after you run the application:

Image: AppFlowy window

If using a virtual machine, run the Linux GUI application through x11 on windows (use MobaXterm) for instance:

export DISPLAY=localhost:10

Miscellaneous: Running the application without building (using VS Code)

{% hint style="warning" %} Do not use the flatpak distribution of VS Code!
****The flatpak VS Code is sandboxed and uses an isolated shell environment, and cannot access any binaries or libraries installed in your system, including your default system shell. {% endhint %}

1. Open the frontend folder located at xx/AppFlowy/ with VS Code.
2. Go to the Run and Debug tab and then click AF-desktop: Clean + Rebuild All for the first time running.