Download • Fork • License • Documentation • Version 3.90.3
Here it is assumed you are running Ubuntu Linux 20.04.6 LTS
Install the dependencies (for Mac OS users follow this)
-
Install Docker and Docker-Compose:
$ sudo apt update $ sudo apt install apt-transport-https ca-certificates curl software-properties-common $ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - $ sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable" $ sudo apt install docker-ce
$ sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose $ sudo chmod +x /usr/local/bin/docker-compose -
Install python3 and other required tools:
$ sudo apt 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 libssl-dev libbz2-dev \ libncurses5-dev libreadline-dev libsqlite3-dev
-
Install pyenv for Python environment management since we make use of Python 3.6.15:
$ curl https://pyenv.run | bash -
Install Python 3.6.15 using pyenv:
$ pyenv install 3.6.15
-
Install NodeJS LTS version and npm:
$ sudo apt install nodejs npm
-
Install grunt-cli:
$ sudo npm install -g grunt-cli
-
Install volta:
$ curl https://get.volta.sh | bash
-
Run docker-compose to spin up image with elasticsearch, redis and mongodb:
$ cd liveblog $ docker-compose -f docker/docker-compose-dev-services.yml up -
Create a virtual environment and install server dependencies:
$ cd server $ pyenv virtualenv 3.6.15 env $ pyenv activate env $ pip install -r requirements.txt -
Add the default data:
$ python3 manage.py app:initialize_data; $ python3 manage.py users:create -u admin -p admin -e 'admin@example.com' --admin ; $ python3 manage.py register_local_themes ;
-
Start the server within the virtual environment:
$ honcho -f ../docker/Procfile-dev start
-
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)
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)
-
$ sudo apt-get install docker.io
and make sure you can run docker without sudo.
-
$ sudo apt-get install python-virtualenv $ virtualenv env
-
$ . env/bin/activate $ pip install -r docker/requirements.txt -
$ ./scripts/docker-local-demo.sh
-
$ 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/fig_wrapper.sh bash -c "\ python3 manage.py app:initialize_data ;\ echo '+++ sample data was prepopulated' ;\ python3 manage.py users:create -u admin -p admin -e 'admin@example.com' --admin ;\ echo '+++ new user has been created' ;\ python3 manage.py 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/fig_wrapper.sh bash -c "\ curl -X POST elastic:9200/liveblog python3 manage.py 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
Run liveblog front end in production mode
cd client
grunt build --force
grunt connect:build