Skip to content

Sourcefabric's Live Blog is an open source web app that enables journalists to provide immediate and ongoing coverage on rapidly evolving news events.


Notifications You must be signed in to change notification settings


Repository files navigation


DownloadForkLicenseDocumentationVersion 3.86.0

Liveblog CI


Liveblog Setup

Liveblog local setup (recommended)

Here I'm assuming you are running Ubuntu Linux 16.04

Install the dependencies (for Mac OS users follow this)

  • Install MongoDB and Redis:

    $ sudo apt-get install mongodb redis-server
  • Install Elasticsearch

    We currently require a specific version of elastic search (not sure why we need that, but it might come in a handy later on):

    $ wget -qO - | sudo apt-key add -
    $ echo "deb stable main" | sudo tee --append /etc/apt/sources.list.d/elastic.list
    $ sudo apt-get update
    $ sudo apt-get install openjdk-8-jre elasticsearch

    Remove the elasticsearch node discovery functionality:

    $ echo " false" | sudo tee --append /etc/default/elasticsearch
  • Install NodeJS LTS version:

    $ curl -sL | sudo -E bash -
    $ sudo apt-get install nodejs
  • Install python3 and other required tools

    $ sudo apt-get install \
    python3 python3-dev python3-pip python3-lxml \
    build-essential libffi-dev git \
    libtiff5-dev libjpeg8-dev zlib1g-dev \
    libfreetype6-dev liblcms2-dev libwebp-dev \
    curl libfontconfig virtualenv libssl-dev
  • Install grunt-cli:

    $ sudo npm install -g grunt-cli

Configure the server

  • Create virtual environment and install server dependencies

    $ cd server
    $ virtualenv -p python3 env
    $ source env/bin/activate
    $ pip install 'pip<=20.2.3'
    $ pip install 'setuptools<50'
    $ pip install -r requirements.txt
  • Add the default data:

    $ python3 app:initialize_data;
    $ python3 users:create -u admin -p admin -e '' --admin ;
    $ python3 register_local_themes ;
  • Start the server within the virtual environment

    $ honcho -f ../docker/Procfile-dev start

If you encounter any connection errors from elastic search:

elasticsearch.exceptions.ConnectionError: ConnectionError(<urllib3.connection.HTTPConnection object at 0x7f9434838358>: Failed to establish a new connection: [Errno 111] Connection refused) caused by: NewConnectionError(<urllib3.connection.HTTPConnection object at 0x7f9434838358>: Failed to establish a new connection: [Errno 111] Connection refused)

You will need to restart and elasticsearch and wait 10 seconds before starting honcho.

sudo service elasticsearch restart
sleep 10
honcho -f ../docker/Procfile-dev start
In Live Blog version 3.4 we updated the Superdesk core libraries to a version higher than v1.8. If you plan to use Amazon S3 to store your assets, please check this information)

Configure the client

  • Install dependencies for the client

    $ cd client
    $ npm install
  • Run the client server:

    $ grunt --force server --server='http://localhost:5000/api' --ws='ws://localhost:5100'

You can now access your local setup at http://localhost:9000 (user: admin, password: admin)

Liveblog Setup using Docker

  • Install Docker

    $ sudo apt-get install

    and make sure you can run docker without sudo.

  • Create python virtualenv

    $ sudo apt-get install python-virtualenv
    $ virtualenv env
  • Install docker-compose

    $ . env/bin/activate
    $ pip install -r docker/requirements.txt
  • Running Prebuilt Setup

    $ ./scripts/
  • Running Development Setup

    $ cd docker
    # start the containers
    $ docker-compose -f docker-compose-dev.yml -p lbdemo up -d
    # continue below once mongodb, elasticsearch and redis are ready to accept connections
    # To initialise data
    $ docker-compose -p lbdemo -f ./docker-compose-dev.yml run superdesk ./scripts/ bash -c "\
    python3 app:initialize_data ;\
    echo '+++ sample data was prepopulated' ;\
    python3 users:create -u admin -p admin -e '' --admin ;\
    echo '+++ new user has been created' ;\
    python3 register_local_themes ;\
    echo '+++ liveblog: local themes were registered';"

    You can access your local setup at http://localhost:9000 (user: admin, password: admin) once the server is ready

    If you encounter the following error on logging in to liveblog in the server logs

    elasticsearch.exceptions.NotFoundError: TransportError(404, 'IndexMissingException[[liveblog] missing]')

    Run the below commands:

    $ docker-compose -p lbdemo -f ./docker-compose-dev.yml run superdesk ./scripts/ bash -c "\
    curl -X POST elastic:9200/liveblog
    python3 app:rebuild_elastic_index --index=liveblog"


Run the behavior tests for the syndication feature

cd server
behave --format progress2 --logging-level ERROR features/syndication.feature

Vagrant LXC Installation

Setting things up

Only works on Linux

cd /tmp
wget -c
sudo dpkg -i vagrant_1.8.6_x86_64.deb
rm vagrant_1.8.6_x86_64.deb
vagrant plugin install vagrant-lxc

Create the configuration file for the frontend

cd ~/code/liveblog
cp client/config.sample.js client/config.js

Start the virtual machine

cd ~/code/liveblog
sudo rm -rf client/data client/dist/* client/.tmp server/src
vagrant destroy
vagrant up
vagrant ssh

Once in the virtual machine:


Once the provisioning is done while still in the virtual machine:



Run liveblog front end in production mode

cd client
grunt build --force
grunt connect:build