censhare WP uses Webpack technology and requires Keycloak for identity management. Follow this tutorial to set up censhare WP.

Introduction

There are some important changes regarding the installation and configuration of censhare WP. Besides the censhare Server, you must set up additional components to enable the communication between the censhare Server, Keycloak, and the censhare clients. 

Prerequisites

You should be familiar with:

  • How to administrate Keycloak

  • How to install and update RPM packages

  • How to administrate services that run with systemd.

    systemd  is used to run the relevant services. systemd is a system and service manager for Linux operating systems.

Download packages

For all components besides the database, censhare provides RPM packages.

To retrieve the required RPMs, you need access to the RPM repository. If you do not have any credentials, create a support ticket.


Download the packages of the latest version with a command similar to this:

curl --user repo-user https://rpm.censhare.com/artifactory/webpack-release/2021.2.1/webpack-2021.2.1.tar.gz -o webpack-2021.2.1.tar.gz



ComponentUseRPM package

censhare Server and database

censhare Server 

Application server 

Soft dependencies on the different censhare Server versions are listed in:
/opt/corpus/censhare/censhare-Server/redistributed.txt

https://rpm.censhare.com/censhare-release-rpm/stable/censhare/2021/2/

censhare-Server-2021.2.1-34.0.noarch.rpm 


databasePostgreSQL or Oracle
Authentication and identity management
Keycloak

Mandatory

Identity provider, authentication solution. censhare provides Keycloak v16.1.1 as RPM package

Existing Keycloak installations can be incorporated. censhare WP supports Keycloak as of v9 but we recommend to use the latest version 16.1.1.

Keycloak configuration

https://rpm.censhare.com/tools-release-rpm/keycloak-16.1.1-3-8.el7.x86_64.rpm

or

https://rpm.censhare.com/tools-release-rpm/keycloak-16.1.1-8.el7.src.rpm

censhare tools 


Cloud Gateway

Mandatory

The Cloud Gateway is used to route the incoming requests from the web browser. The requests are directed to:

  • KeyCloak server for authentication
  • Static Resource Server to serve the static parts of the user interface
  • censhare Server to serve requested data

https://rpm.censhare.com/tools-release-rpm/

censhare-cloud-gateway-1.0.14-0.noarch.rpm

Static Resource Server

Mandatory

Distributes webpack bundles

https://rpm.censhare.com/tools-release-rpm/

censhare-static-resource-server-2.0.37-0.noarch.rpm

Google Cloud AI microservice

Optional

Provides Google Cloud AI analysis in censhare

Configuration details

https://rpm.censhare.com/tools-release-rpm/

censhare-google-ai-1.1.2-0.noarch.rpm

Social Media microservice

Optional

Required to publish content from censhare to social networks (Twitter, Facebook, YouTube)

https://rpm.censhare.com/tools-release-rpm/

censhare-social-media-1.0.3-0.noarch.rpm

webpack for web browser
webpack

Mandatory

Bundles static resources to serve them to the web browser.

The webpack files contain the user-language specific static files of the user interface. For each language, separate webpack files are necessary. Also, for any other customizations in the custom folder, separate webpack files are needed.

Configuration details

https://rpm.censhare.com/artifactory/webpack-release/2021.2.1/webpack-2021.2.1.tar.gz
censhare Clients
censhare Clients

The censhare clients (Java-based and Admin) and censhare Service Client can be used as before. There are no changes regarding installation or configuration.

For example:

https://rpm.censhare.com/censhare-release-rpm/stable/censhare/2021/2/ 

censhare-Service-Client-2021.2.1-34.0.noarch.rpm 



Add repositories

Add the repositories for the RPM packages to the system:

  1. Go to  /etc/yum.repos.d/

  2. If no repository for censhare Server exists, create it with suffix repo. For example censhare-server.repo 

    [censhare-server]
    name=censhare-server
    baseurl = https://USER:PASSWORD@rpm.censhare.com/censhare-release-rpm/stable/censhare/2021/2/1
    enabled=0
    gpgcheck=1
    gpgkey = https://repos.censhare.com/6CAE093C.pub 
  3. If no repository for the censhare tools exists, create it with suffix repo. For example censhare-tools.repo 

    [censhare-tools]
    name=censhare-tools
    baseurl=https://user:password@rpm.censhare.com/tools-release-rpm/
    enabled=0
    gpgcheck=1
    gpgkey=https://rpm.censhare.com/public/6CAE093C.pub

Import GPG key

Import the GPG key into your system. It is required to verify your downloads.

rpm --import https://rpm.censhare.com/public/6CAE093C.pub

Install server and database

Install or update censhare Server

Update to censhare 2021.2.1 or the latest available version into the censhare-server repository:

rpm -i censhare-Server-2021.2.1-34.0.noarch.rpm 
 # or
yum install --enablerepo="censhare*" censhare-Server
 # or
yum update --enablerepo="censhare*" censhare-Server

Install database

You can use PostgreSQL or Oracle databases. If you already have a running censhare instance, skip this step.

For information on installing the database:

Test REST API

curl http://localhost:9000/ws/rest/service/webserver/rest/csLocale -u censhare:

Install or update censhare Service Client (optional)

Update to censhare 2021.2.1 or the latest available version into the censhar-server repository :

rpm -i censhare-Service-Client-2021.2.1-34.0.noarch.rpm 
 # or
yum install --enablerepo="censhare*" censhare-Service-Client
# or
yum update --enablerepo="censhare*" censhare-Service-Client

Install Keycloak

If you already have a running Keycloak installation, skip this step. 

If you need to install Keycloak, go to the location where you installed censhare WP:

rpm -i keycloak-16.1.1-8.el7.x86_64.rpm
# or
yum install --enablerepo="censhare*" keycloak
# or
yum update --enablerepo="censhare*" keycloak

Install the censhare tools

Install Cloud Gateway


rpm -i censhare-cloud-gateway-1.0.14-0.noarch.rpm
# or 
yum install --enablerepo="censhare*" censhare-cloud-gateway

Install Static Resource Server

rpm -i censhare-static-resource-server-2.0.37-0.noarch.rpm
# or 
yum install --enablerepo="censhare*" censhare-static-resource-server   

Install optional microservices

Install Google Cloud AI:

rpm -i censhare-google-ai-1.1.2-0.noarch.rpm
# or
yum install --enablerepo="censhare*" censhare-google-ai-microservice

Install Social Media service. For more information, see Installation details.

rpm -i censhare-social-media-1.0.3-0.noarch.rpm
# or
yum install --enablerepo="censhare*" censhare-social-media

Install or update the censhare clients

The censhare clients and censhare Service Client can be used as before. There are no changes regarding installation or configuration.

Update to censhare 2021.2.1 or the latest available version.

For more information, see Install censhare clients.

Check installed packages

List censhare packages

yum list *censhare*

Update

Check for updates

yum check-update --enablerepo="censhare*"

Update packages

yum update --enablerepo="censhare*" PACKAGE_NAME  

# for example

yum update --enablerepo="censhare*" censhare-static-resource-server 

# or

yum update all --enablerepo="censhare*"

Next steps

Configure censhare WP

Configure Keycloak