Quick start

Quick Start from docker

We provide a docker image build on centos6 with a sample dataset in it.

docker pull peterzhang921/cboard:0.4.1
docker run --rm -itd --name=cboard -p 8026:8080 --privileged=true peterzhang921/cboard:0.4.1

# after docker container is start then attach into it and start tomcat server
docker attach cboard
/opt/apache-tomcat/bin/startup.sh

# wait after server successfully started
tail -f /opt/apache-tomcat/logs/catalina.out

Acccess cboard with url  http://docker-hostip:8026/cboard

• username: admin , password: root123
• There is no prepared charts and dashboard in it
• Meta data of CBoard is stotred in embedded DB H2 with file storage, user can change or add your own configuration by yourself then build project and docker image again
  • how to rebuild docker

  # use configuration files in h2 folder, use env parameter then all the files in h2 folder will overwrite same files in resource folder
  maven clean package -Denv=h2
  # build docker image
  docker build --network=host -t cboard .

Build project by yourself

Prerequisite

Before the start, make sure you have setup environment:

• JDK version above 1.8
• MySQL
• Maven
• Tomcat
• Phantomjs (for export dashbaord)
• Mail Servier

How to build project

• 1 Download or git clone project

  git clone https://github.com/yzhang921/CBoard.git

• 2 Install metadata of CBoard (take MySQL database as example)

  • 2.1 Install demo metadata and sample foodmart db
    • Download  cboard_demo & foodmart
    • Enter into the path of these two files
    • Use MySQL Command Line tool login and execute

              source cboard_demo.sql
        source foodmart.sql
    

    • After success completed, check if cboard_demo2 and foodmart2 databases have been created
  • 2.2 You can alternative choose start from a blank setting

        -- CREATE DATEBASE cboard;
        Execute ddl to create metadata table: sql/mysql/mysql.sql

• 3 Modify metadata connection properties file according to your db environment

      CBoard/src/main/resources/config.properties
  

  validationQuery=SELECT 1
  jdbc_url=jdbc:mysql://localhost:3306/cboard # set to your metadata db connection url, if you are using demo db, change db name to cboard_demo2
  jdbc_username=root # change to the username/password of your db
  jdbc_password=111111
  
  # Service configuration
  dataprovider.resultLimit=300000
  admin_user_id=1
  phantomjs_path=D:/phantomjs-2.1.1-windows/bin/phantomjs.exe  # change to the install path of your phantomjs
  web_port=8026 #
  web_context=  # web context name of your app, can be blank for ROOT deploy
  
  # configuration of Mail service
  mail.smtp.host=127.0.0.1
  mail.smtp.port=8825
  [email protected]
  #[email protected]
  #mail.smtp.password=111111
  #mail.smtp.ssl.checkserveridentity=false
  
  # Cache Properties if you wanna use redis as cache layer
  cache.redis.hostName=127.0.0.1
  cache.redis.port=6379

• 4 Comile and package project with Maven

      cd root path of CBoard
  # Install SQLServer JDBC Driver into your local respository
  mvn install:install-file -Dfile=lib/sqljdbc4-4.0.jar -DgroupId=com.microsoft.sqlserver -DartifactId=sqljdbc4 -Dversion=4.0 -Dpackaging=jar
  mvn clean package
  

• 5 Deploy war to Tomcat application

• Copy CBoard/target/cboard.war to webapp folder of Tomcat and rename cboard.war would be better to change name to ROOT.war
• Start up Tomcat

• 6 Access CBoard

  http://_yourserverip_:8080
Default login username and passwor: admin/root123

• 7 For Demo DB user, check and test the source of foodmart