Are you interested in contributing but don’t know where to start? Head over to the documentation or start by following these step-by-step instructions and build CODE from scratch.

Build CODE

Build Collabora Online Development Edition. Choose your operating system or opt for using Gitpod (hack, build, debug and run entirely using a web-browser) from the list below for straightforward instructions to get you going quickly. If you are a seasoned developer with commit access, or just feeling extraordinarily brave, feel free to follow the general instructions.

GNU/Linux openSUSE GNU/Linux Debian GNU/Linux Ubuntu GNU/Linux Fedora GNU/Linux Arch (Manjaro etc.) GNU/Linux General Instructions Gitpod (Windows, Mac, Linux, etc)

Gitpod

On top of our daily LibreOffice core archives, we have also added integration support for Gitpod, a cloud based development environment. Now you can start hacking Collabora Online (COOL) in under ~5 minutes!

Steps to quick start:

  • Sign-up on Gitpod.io with your GitHub account
  • Install the proper extension for your browser
  • Go to COOL repo
  • Click on the green Gitpod button near the top of the GitHub repo page
GitPod green button on GitHub
  • You should be redirected to gitpod.io where you can set your workspace settings. Please choose large container:
GitPod.io new workspace
  • Make sure your browser is not blocking windows/tabs from opening from the gitpod workspace URL (maybe add *.gitpod.io to your browser’s whitelist)
  • VNC tab will open automatically if not just click on the left icon Remote explorer and click 6080. You will see a tab completely black, that’s normal.
Gitpod, your development environment for Collabora Online on the cloud
  • Wait for a few minutes, and you will have a full development environment with COOL already cloned & built, ready-to-start/develop.
The left pane will automatically start to build the software for you. The right waits for the 9980 port to be available and displays interesting comments

  • The GitPod tasks will run automatically and further instructions will be printed out right in the terminal

  • After the build finishes (left terminal pane) you will see links. Copy the URL ending with: hello-world.odt

  • In the right terminal pane execute the following: firefox [paste copied URL here] or /usr/bin/chromium [paste copied URL here]

  • Now head over to the web browser tab where the VNC is opened, you will see Firefox/Chromium opening there, maximize and have fun.

  • You can also run cypress tests via GitPod. To do so, please prepend CYPRESS_BROWSER="/usr/bin/chromium" ("firefox" can also be used). Example:

  • Don’t forget to fork the main repo |226x56

  • And set the remote address in .git/config to point to your fork’s address with this command:

git remote set-url origin https://github.com/PUT-YOUR-GITHUB-USERNAME-HERE/online.git

Happy hacking! : )

First published on Collabora Online Community Roundup #2

Running & Hacking

Now do:

make run

The output will contain the links that you can directly follow to see Writer, Calc, and Impress test documents in your browser.

Hacking it

When you change a JavaScript file (they are located under the browser/ subdirectory), you need to stop the existing CODE instance and issue make run again, because the files are cached. Alternatively you can export a variable like:

export COOL_SERVE_FROM_FS=1

to avoid the caching, so that you can just Shift+Reload the pages to see the new content.

If you are using VS Code as your IDE and want to run code in your local VS Code with local ports, follow these steps:

  1. Open Gitpod and navigate to the top left option.
  2. Select Gitpod: Open in VS Code.
  3. Install the following extensions in your VS Code: Gitpod, Remote - SSH, Remote - SSH: Editing Configuration Files, and Remote Explorer.
  4. Configure your SSH key in VS Code.
  5. Once everything is set up, type make run. This will allow you to access the hosted port on your local machine.

openSUSE

The instructions below have been prepared for and tested on openSUSE Leap 15.3. You might need to do small adjustments for other releases.

Dependencies

We need LibreOffice core, POCO library and several other libraries and tools to build CODE. Open a terminal and follow the steps below.

# For Leap 15.5
zypper ar http://download.opensuse.org/repositories/devel:/libraries:/c_c++/15.5/devel:libraries:c_c++.repo

If this is fresh instalation it might be worth install devel-basis pattern: Minimal set of tools for compiling and linking applications. It will bring in things like git, gcc, etc.

sudo zypper install -t pattern devel_basis

Now go ahead and install the following packages

zypper in poco-devel libcap-progs python3-polib libcap-devel npm libtool cppunit-devel pam-devel python3-lxml chromium

# If you are using Leap 15.4 please install this aditional compatability library
zypper in libpng16-compat-devel

LibreOffice

CODE needs LibreOffice to be built to run. However, it takes a considerable amount of time and brings in extra complexity. So, we will instead download a daily built archive which contains only the pieces that are absolutely necessary. If you are working only on the online side, without doing any code-level changes on the LibreOffice core, or you just want to quickly get going to do some small fixes, then this will be enough for you. Otherwise, refer to the general instructions.

Now download a daily-built archive of LibreOffice core:

wget https://github.com/CollaboraOnline/online/releases/download/for-code-assets/core-co-24.04-assets.tar.gz

Extract the contents of the archive:

tar xvf core-co-24.04-assets.tar.gz

Export the location of the extracted contents as a variable before changing directory:

export LOCOREPATH=$(pwd)

# Or make it persistent as part of your .bashrc with
echo "export LOCOREPATH=$(pwd)" >> ~/.bashrc && source ~/.bashrc

Building CODE

You need to clone it, run autoconf/automake, configure and build using the GNU make. Before moving on, fork the repo if you haven’t done that yet.

Now clone the forked repo:

git clone https://github.com/YOURUSERNAME/online.git collabora-online

Switch to the local clone’s directory:

cd collabora-online

Run autogen to generate the configure file:

./autogen.sh

Run the generated configure script with proper parameters:

./configure --enable-silent-rules --with-lokit-path=${LOCOREPATH}/include \
            --with-lo-path=${LOCOREPATH}/instdir \
            --enable-debug --enable-cypress

Note: you can also add --disable-ssl instead of changing coolwsd.xml every time you want to disable ssl.

Start the actual build, which might take from a few minutes to half an hour (or more) depending on how powerful your machine is:

make -j $(nproc)

Running & Hacking

Now do:

make run

The output will contain the links that you can directly follow to see Writer, Calc, and Impress test documents in your browser.

Hacking it

When you change a JavaScript file (they are located under the browser/ subdirectory), you need to stop the existing CODE instance and issue make run again, because the files are cached. Alternatively you can export a variable like:

export COOL_SERVE_FROM_FS=1

to avoid the caching, so that you can just Shift+Reload the pages to see the new content.

Fedora

The instructions below have been prepared for and tested on Fedora 37. You might need to do small adjustments for Fedora-based distributions.

Dependencies

We need LibreOffice core, POCO library and several other libraries and tools to build CODE.

Open a terminal and follow the steps below:

sudo dnf install poco-devel gcc gcc-c++ python3-polib python3-lxml \
                 libtool libstdc++-devel libpng libpng-devel \
                 cppunit-devel nodejs-devel chromium \
                 libzstd-devel libcap-devel pam-devel

LibreOffice

CODE needs LibreOffice to be built to run. However, it takes a considerable amount of time and brings in extra complexity. So, we will instead download a daily built archive which contains only the pieces that are absolutely necessary. If you are working only on the online side, without doing any code-level changes on the LibreOffice core, or you just want to quickly get going to do some small fixes, then this will be enough for you. Otherwise, refer to the general instructions.

Now download a daily-built archive of LibreOffice core:

wget https://github.com/CollaboraOnline/online/releases/download/for-code-assets/core-co-24.04-assets.tar.gz

Extract the contents of the archive:

tar xvf core-co-24.04-assets.tar.gz

Export the location of the extracted contents as a variable before changing directory:

export LOCOREPATH=$(pwd)

# Or make it persistent as part of your .bashrc with
echo "export LOCOREPATH=$(pwd)" >> ~/.bashrc && source ~/.bashrc

Building CODE

You need to clone it, run autoconf/automake, configure and build using the GNU make. Before moving on, fork the repo if you haven’t done that yet.

Now clone the forked repo:

git clone https://github.com/YOURUSERNAME/online.git collabora-online

Switch to the local clone’s directory:

cd collabora-online

Run autogen to generate the configure file:

./autogen.sh

Run the generated configure script with proper parameters:

./configure --enable-silent-rules --with-lokit-path=${LOCOREPATH}/include \
            --with-lo-path=${LOCOREPATH}/instdir \
            --enable-debug --enable-cypress

Note: you can also add --disable-ssl instead of changing coolwsd.xml every time you want to disable ssl.

Start the actual build, which might take from a few minutes to half an hour (or more) depending on how powerful your machine is:

make -j $(nproc)

Running & Hacking

Now do:

make run

The output will contain the links that you can directly follow to see Writer, Calc, and Impress test documents in your browser.

Hacking it

When you change a JavaScript file (they are located under the browser/ subdirectory), you need to stop the existing CODE instance and issue make run again, because the files are cached. Alternatively you can export a variable like:

export COOL_SERVE_FROM_FS=1

to avoid the caching, so that you can just Shift+Reload the pages to see the new content.

Arch

The instructions below have been prepared for and tested on Manjaro 21.2.3. You might need to do small adjustments for Arch and/or other Arch-based distributions.

Dependencies

We need LibreOffice core, POCO library and several other libraries and tools to build CODE.

Open a terminal and follow the steps below:

sudo pacman -Syu libcap libcap-ng lib32-libcap libpng poco cppunit nodejs npm chromium python-lxml

Additionally you will need to install python-polib. You can do this using pip (as below) or using the python-polib AUR package

sudo pacman -Syu python-pip
sudo pip install polib

LibreOffice

CODE needs LibreOffice to be built to run. However, it takes a considerable amount of time and brings in extra complexity. So, we will instead download a daily built archive which contains only the pieces that are absolutely necessary. If you are working only on the online side, without doing any code-level changes on the LibreOffice core, or you just want to quickly get going to do some small fixes, then this will be enough for you. Otherwise, refer to the general instructions.

Now download a daily-built archive of LibreOffice core:

wget https://github.com/CollaboraOnline/online/releases/download/for-code-assets/core-co-24.04-assets.tar.gz

Extract the contents of the archive:

tar xvf core-co-24.04-assets.tar.gz

Export the location of the extracted contents as a variable before changing directory:

export LOCOREPATH=$(pwd)

# Or make it persistent as part of your .bashrc with
echo "export LOCOREPATH=$(pwd)" >> ~/.bashrc && source ~/.bashrc

Building CODE

You need to clone it, run autoconf/automake, configure and build using the GNU make. Before moving on, fork the repo if you haven’t done that yet.

Now clone the forked repo:

git clone https://github.com/YOURUSERNAME/online.git collabora-online

Switch to the local clone’s directory:

cd collabora-online

Run autogen to generate the configure file:

./autogen.sh

Run the generated configure script with proper parameters:

./configure --enable-silent-rules --with-lokit-path=${LOCOREPATH}/include \
            --with-lo-path=${LOCOREPATH}/instdir \
            --enable-debug --enable-cypress

Note: you can also add --disable-ssl instead of changing coolwsd.xml every time you want to disable ssl.

Start the actual build, which might take from a few minutes to half an hour (or more) depending on how powerful your machine is:

make -j $(nproc)

Running & Hacking

Now do:

make run

The output will contain the links that you can directly follow to see Writer, Calc, and Impress test documents in your browser.

Hacking it

When you change a JavaScript file (they are located under the browser/ subdirectory), you need to stop the existing CODE instance and issue make run again, because the files are cached. Alternatively you can export a variable like:

export COOL_SERVE_FROM_FS=1

to avoid the caching, so that you can just Shift+Reload the pages to see the new content.

Debian

The instructions below have been prepared for and tested on Debian GNU/Linux 11 (bullseye). You might need to do small adjustments for other releases.

Note: Sometimes Debian comes without sudo preinstalled. If you do not have sudo, you will need to run apt install -y sudo as root. It is not good enough to only run the commands which require sudo below as root, as sudo is also run during make

Dependencies

We need LibreOffice core, POCO library and several other libraries and tools to build CODE. Open a terminal and follow the steps below.

Lets start by installing the dialog package, which will be needed while installing some of the other packages:

sudo apt install -y dialog

Now install the rest of the required packages:

sudo apt install -y libpoco-dev python3-polib libcap-dev npm \
                    libpam-dev wget git build-essential libtool \
                    libcap2-bin python3-lxml libpng-dev libcppunit-dev \
                    pkg-config fontconfig chromium

LibreOffice

CODE needs LibreOffice to be built to run. However, it takes a considerable amount of time and brings in extra complexity. So, we will instead download a daily built archive which contains only the pieces that are absolutely necessary. If you are working only on the online side, without doing any code-level changes on the LibreOffice core, or you just want to quickly get going to do some small fixes, then this will be enough for you. Otherwise, refer to the general instructions.

Now download a daily-built archive of LibreOffice core:

wget https://github.com/CollaboraOnline/online/releases/download/for-code-assets/core-co-24.04-assets.tar.gz

Extract the contents of the archive:

tar xvf core-co-24.04-assets.tar.gz

Export the location of the extracted contents as a variable before changing directory:

export LOCOREPATH=$(pwd)

# Or make it persistent as part of your .bashrc with
echo "export LOCOREPATH=$(pwd)" >> ~/.bashrc && source ~/.bashrc

Building CODE

You need to clone it, run autoconf/automake, configure and build using the GNU make. Before moving on, fork the repo if you haven’t done that yet.

Now clone the forked repo:

git clone https://github.com/YOURUSERNAME/online.git collabora-online

Switch to the local clone’s directory:

cd collabora-online

Run autogen to generate the configure file:

./autogen.sh

Run the generated configure script with proper parameters:

./configure --enable-silent-rules --with-lokit-path=${LOCOREPATH}/include \
            --with-lo-path=${LOCOREPATH}/instdir \
            --enable-debug --enable-cypress

Note: you can also add --disable-ssl instead of changing coolwsd.xml every time you want to disable ssl.

Start the actual build, which might take from a few minutes to half an hour (or more) depending on how powerful your machine is:

make -j $(nproc)

Running & Hacking

Now do:

make run

The output will contain the links that you can directly follow to see Writer, Calc, and Impress test documents in your browser.

Hacking it

When you change a JavaScript file (they are located under the browser/ subdirectory), you need to stop the existing CODE instance and issue make run again, because the files are cached. Alternatively you can export a variable like:

export COOL_SERVE_FROM_FS=1

to avoid the caching, so that you can just Shift+Reload the pages to see the new content.

Ubuntu

The instructions below have been prepared for and tested on Ubuntu 20.04 LTS. You might need to do small adjustments for other releases.

Dependencies

We need LibreOffice core, POCO library and several other libraries and tools to build CODE. Open a terminal and follow the steps below.

Lets start by installing the dialog package, which will be needed while installing some of the other packages:

sudo apt install -y dialog

Now install the rest of the required packages:

sudo apt install -y libpoco-dev python3-polib libcap-dev npm \
                    libpam-dev libzstd-dev wget git build-essential libtool \
                    libcap2-bin python3-lxml libpng-dev libcppunit-dev \
                    pkg-config fontconfig snapd chromium-browser

Note: Chomium is needed and used in cypress tests. Ubuntu has no chromium deb packages in its repositories, only a dummy pacakge that points to the respective snap. Probably best to make sure you have snapd installed and install chromium-browser which in turn will install the snap package.

LibreOffice

CODE needs LibreOffice to be built to run. However, it takes a considerable amount of time and brings in extra complexity. So, we will instead download a daily built archive which contains only the pieces that are absolutely necessary. If you are working only on the online side, without doing any code-level changes on the LibreOffice core, or you just want to quickly get going to do some small fixes, then this will be enough for you. Otherwise, refer to the general instructions.

Now download a daily-built archive of LibreOffice core:

wget https://github.com/CollaboraOnline/online/releases/download/for-code-assets/core-co-24.04-assets.tar.gz

Extract the contents of the archive:

tar xvf core-co-24.04-assets.tar.gz

Export the location of the extracted contents as a variable before changing directory:

export LOCOREPATH=$(pwd)

# Or make it persistent as part of your .bashrc with
echo "export LOCOREPATH=$(pwd)" >> ~/.bashrc && source ~/.bashrc

Building CODE

You need to clone it, run autoconf/automake, configure and build using the GNU make. Before moving on, fork the repo if you haven’t done that yet.

Now clone the forked repo:

git clone https://github.com/YOURUSERNAME/online.git collabora-online

Switch to the local clone’s directory:

cd collabora-online

Run autogen to generate the configure file:

./autogen.sh

Run the generated configure script with proper parameters:

./configure --enable-silent-rules --with-lokit-path=${LOCOREPATH}/include \
            --with-lo-path=${LOCOREPATH}/instdir \
            --enable-debug --enable-cypress

Note: you can also add --disable-ssl instead of changing coolwsd.xml every time you want to disable ssl.

Start the actual build, which might take from a few minutes to half an hour (or more) depending on how powerful your machine is:

make -j $(nproc)

Running & Hacking

Now do:

make run

The output will contain the links that you can directly follow to see Writer, Calc, and Impress test documents in your browser.

Hacking it

When you change a JavaScript file (they are located under the browser/ subdirectory), you need to stop the existing CODE instance and issue make run again, because the files are cached. Alternatively you can export a variable like:

export COOL_SERVE_FROM_FS=1

to avoid the caching, so that you can just Shift+Reload the pages to see the new content.

Build CODE & LO

Dependencies

The CODE must be built on Linux, and you need the following:

  • LibreOffice
    • Either build LibreOffice from source, or download a daily built archive (see below)
  • Poco library: http://pocoproject.org/
    • Either use the package from your distro, or build it yourself, ideally 1.10.1 or later
  • libpng, libcap-progs, libtool, automake, autoconf, pkg-config, sudo, pam
    • Use the packages from your distro

You may also want to have the following optional dependencies:

  • Chromium
    • Needed for running cypress tests
  • The lxml and polib libraries for python
    • Needed for building javascript
    • These can both be installed via pip or your distro’s packages
  • Cppunit
    • Needed for unit tests
  • Node.js
    • Needed for building the JS parts (not needed if you build them on another linux machine)

LibreOffice

CODE needs LibreOffice to be built to run. You have two options to meet this requirement: either by building it locally (Option A - recommended), or by downloading a daily built archive (Option B - quick & dirty) which contains only the absolutely necessary pieces. If you are working only on the online side, without doing any code-level changes on the LibreOffice core, or you just want to quickly get going to do some small fixes, you may prefer the second way.

Option A - Build LibreOffice locally (Recommended)

The build process for LibreOffice is described on their wiki. However, a few modifications are needed in order to support building CODE.

https://wiki.documentfoundation.org/Development/BuildingOnLinux

Install the dependencies. The lists of dependencies and commands for various distributions of Linux are avialable on the LibreOffice Wiki linked above.

Clone the repository and switch to the Collabora Online branch:

git clone https://gerrit.libreoffice.org/core libreoffice
cd libreoffice
git checkout distro/collabora/co-24.04

Configure and build, adding the following configuration options to autogen.sh or autogen.input:

./autogen.sh --with-distro=CPLinux-LOKit --without-package-format

make -j $(nproc)

You can expect this process to take at least an hour or two the first time, possibly more depending on your machine and your internet connection. Subsequent builds will be faster.

Option B - Download a Daily-Built Archive of LibreOffice (Quick & Dirty)

CODE needs LibreOffice to be built to run. However, it takes a considerable amount of time and brings in extra complexity. So, we will instead download a daily built archive which contains only the pieces that are absolutely necessary. If you are working only on the online side, without doing any code-level changes on the LibreOffice core, or you just want to quickly get going to do some small fixes, then this will be enough for you. Otherwise, refer to the general instructions.

Now download a daily-built archive of LibreOffice core:

wget https://github.com/CollaboraOnline/online/releases/download/for-code-assets/core-co-24.04-assets.tar.gz

Extract the contents of the archive:

tar xvf core-co-24.04-assets.tar.gz

Export the location of the extracted contents as a variable before changing directory:

export LOCOREPATH=$(pwd)

# Or make it persistent as part of your .bashrc with
echo "export LOCOREPATH=$(pwd)" >> ~/.bashrc && source ~/.bashrc

You should now have two new directories extracted: instdir and include. You will use the locations of these directories for the configure parameters in the following steps.

Building CODE

You need to clone it, run autoconf/automake, configure and build using the GNU make:

git clone https://github.com/YOURUSERNAME/online.git collabora-online

Switch to the local clone’s directory:

cd collabora-online

Run autogen to generate the configure file:

./autogen.sh

Run the generated configure script with proper parameters:

./configure --enable-silent-rules --with-lokit-path=${LOCOREPATH}/include \
            --with-lo-path=${LOCOREPATH}/instdir \
            --enable-debug --enable-cypress

Note: you can also add --disable-ssl instead of changing coolwsd.xml every time you want to disable ssl.

Start the actual build, which might take from a few minutes to half an hour (or more) depending on how powerful your machine is:

make -j $(nproc)

You can also add extra flags to customize your build:

  • If you built POCO from source, add --with-poco-includes=<POCODIRECTORY>/include --with-poco-libs=<POCODIRECTORY>/lib
  • Add --enable-silent-rules to create less verbose build output
  • Add --enable-cypress to enable tests which use a browser (requires Chromium)

See ./configure --help for the full list of options.

make -j `nproc`

If you want to run the unit tests, use make check instead of make.

Note that the coolforkit program needs the CAP_SYS_CHROOT capability, thus you will be asked the root password when running make as it invokes sudo to run /sbin/setcap.

Running & Hacking

Now do:

make run

The output will contain the links that you can directly follow to see Writer, Calc, and Impress test documents in your browser.

Hacking it

When you change a JavaScript file (they are located under the browser/ subdirectory), you need to stop the existing CODE instance and issue make run again, because the files are cached. Alternatively you can export a variable like:

export COOL_SERVE_FROM_FS=1

to avoid the caching, so that you can just Shift+Reload the pages to see the new content.

Edit page

build make