censhare WP - RPM-based installation

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. Download the packages of the latest version.

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

Component	Use	RPM 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.4-34.0.noarch.rpm
database	PostgreSQL or Oracle
Authentication and identity management
Keycloak	Mandatory Identity provider, authentication solution. censhare provides Keycloak v21.1.2 as RPM package.  If you already use Keycloak, follow instruction on this page to upgrade.	https://rpm.censhare.com/tools-release-rpm/ keycloak-<<version>>.e17.x86_64.rpm
censhare tools
Compatible CGW & SRS versions Up to and including censhare 2022.1 we use Java 11 and for CGW/SRS major version 2. For the exact latest version of the both tools, please check what is available in the RPM repository.
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-core-cloud-gateway-2.x.x-0.noarch.rpm Update installations may require additional steps due to the change in package naming from cloud-gateway to core-cloud-gateway. If your installation is affected, follow these steps.
Static Resource Server	Mandatory Distributes webpack bundles	https://rpm.censhare.com/tools-release-rpm/ censhare-static-resource-server-2.x.x-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.4-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.3/webpack-2021.2.3.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. Java, Admin, and Renderer Clients need to be downloaded from the Download portal.	For example: https://rpm.censhare.com/censhare-release-rpm/stable/censhare/2021/2/  censhare-Service-Client-<version>-<buildID>.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. 
   
   

   CODE

   [censhare-server]
   name=censhare-server
   baseurl = https://USER:PASSWORD@rpm.censhare.com/censhare-release-rpm/stable/censhare/2021/2/4
   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 
   
   

   CODE

   [censhare-tools]
   name=censhare-tools
   baseurl=https://user:password@rpm.censhare.com/tools-release-rpm/
   enabled=0
   gpgcheck=1
   gpgkey=https://user:password@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://user:password@rpm.censhare.com/public/6CAE093C.pub

Install server and database

Install or update censhare Server

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

rpm -i censhare-Server-2021.2.3-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:

• Installing Oracle Database Using RPM Packages

• Installing Postgres

• https://yum.postgresql.org

• Install Oracle and PostgreSQL databases

Initial server configuration and start

If you set up the censhare Server for the first time, follow the steps in Initial censhare Server configuration.

Start the censhare server, for example with this command:

systemctl start censhare.server

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.4 or the latest available version into the censhar-server repository :

rpm -i censhare-Service-Client-2021.2.3-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:

Keycloak v21.1.2 

rpm -i keycloak-21-1.2-1.el7.x86_64.rpm  
# or
yum install --enablerepo="censhare*" keycloak
# or
yum update --enablerepo="censhare*" keycloak

Install the censhare tools

Install Cloud Gateway

Update installations may require additional steps due to the change in package naming from cloud-gateway to core-cloud-gateway. If your installation is affected, follow these steps.

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

Install Static Resource Server

Due to a known issue, we are currently using version 2.0.43.

rpm -i censhare-static-resource-server-2.3.1-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.4-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.

Image relocation (Branding and favicon images)

For upgrade installations from a censhare release 2021.1.1 or below, you need to relocate your images to work with censhare WP.

Install optional services

Install Social Media service

Google AI microservice

CI HUB

Configure session handling

Configure session handling

Check installed packages

yum list *censhare*

Next steps

1. Configure Keycloak
2. Configure censhare WP