Skip to content

developers_setup.md

Latest commit

 

History

History
71 lines (40 loc) · 3.04 KB

developers_setup.md

File metadata and controls

71 lines (40 loc) · 3.04 KB
Raw

Backroll developers’ setup

Here is our recommended developers’ setup to contribute to Backroll.

WSL

If you are on Windows, you can work on linux throught WSL.

Docker

Windows & Linux desktops

If you want to work locally, install Docker Desktop.

To use Docker in WSL, check your WSL integration settings : Settings > Resources > WSL integration.

Linux server

If you plan to work remotely on a linux server :

Visual Studio Code

Install Visual Studio Code.

Extensions

Windows

If you are on Windowns, install the WSL extension. Connect to WSL with Visual Studio Code before cloning the Backroll repository.

Remote developement

If you plan to work remotely on a server, install the remote connexion extensions :

Docker

You can install the Docker extension. It provides a UI to manage containers and other Docker stuff directly into Visual Studio Code. However, it may no guess the full docker compose command you used to set up your containers, so just fallback to the command line.

KVM

To contribute to Backroll, you will need to have an hypervisor and some VMs to play with.

So let’s setup KVM :

  • start with this beginners’ guide - it's deprecated now (07/2025), so just run these commands to install it :
sudo apt update
sudo apt upgrade
sudo apt install -y qemu-kvm libvirt-daemon-system libvirt-clients bridge-utils virt-manager
  • if libvirtd is not running, see this thread

Then create a VM :

  • see this thread : note that virt-manager is a nice tool to quickly create a VM for development purposes
  • if you are using a command line tool, mind that the install iso image may require a graphical interface

If Backroll and KVM are running on the same host (WSL or a linux computer), you can reach the hypervisor by using the special domain name host.docker.internal.

Next steps

To configure and run BackROLL, please visit the Compose Project README. This document will guide you through the configuration process (follow the dev part).