Skip to content

Local Setup

Overview


You can deploy XSK locally using Docker or Tomcat server.

Steps


  1. Deploy as a Docker container or on Tomcat server.

    Prerequisites

    Install Docker.

    1. Pull the XSK Docker image:

      docker pull dirigiblelabs/xsk:latest
      
    2. Start the container:

    docker run --name xsk \
    --rm -p 8080:8080 -p 8081:8081 \
    dirigiblelabs/xsk:latest
    
    docker run --name xsk \
    -v <your-local-directory>:/usr/local/tomcat/target \
    --rm -p 8080:8080 -p 8081:8081 \
    dirigiblelabs/xsk:latest
    
    docker run --name xsk \
    -e DIRIGIBLE_DATABASE_PROVIDER="custom" \
    -e DIRIGIBLE_DATABASE_CUSTOM_DATASOURCES="HANA" \
    -e DIRIGIBLE_DATABASE_DATASOURCE_NAME_DEFAULT="HANA" \
    -e HANA_DRIVER="com.sap.db.jdbc.Driver" \
    -e HANA_URL="jdbc:sap://<hanaHost>?encrypt=true&validateCertificate=false" \
    -e HANA_USERNAME="<hanaUsername>" \
    -e HANA_PASSWORD="<hanaPassword>" \
    --rm -p 8080:8080 -p 8081:8081 \
    dirigiblelabs/xsk:latest
    

    Note

    • Replace the <hanaHost> placeholder with the HANA Cloud host that you're going to use.
    • Replace the <hanaUsername> placeholder with the HANA Cloud username that you're going to use.
    • Replace the <hanaPassword> placeholder with the HANA Cloud password that you're going to use.

    Windows

    For setup on Windows OS, issues may appear with the way the environment variables (-e XXX=YYY) are provided. Either they should be properly escaped, or they could be supplied as *.env file:

    docker run --name xsk \
    --env-file env-variables.env \
    --rm -p 8080:8080 -p 8081:8081 \
    dirigiblelabs/xsk:latest
    
    docker run --name xsk \
    -e JPDA_ADDRESS=0.0.0.0:8000 \
    -e JPDA_TRANSPORT=dt_socket \
    --rm -p 8080:8080 -p 8081:8081 -p 8000:8000 \
    dirigiblelabs/xsk:latest
    

    Prerequisites

    • Java 11 or Java 13 installed (default, required during runtime).
    • Java 8 JRE/JDK installed (additional, required for compatability reasons).
    1. Download ROOT.war for Tomcat from: https://github.com/SAP/xsk/releases/latest

      Note

      For local test & development purposes, we recommend the server distribution.

    2. Configure the Users store under $CATALINA_HOME/conf/tomcat-users.xml:

      <tomcat-users>
          <role rolename="Developer"/>
          <role rolename="Operator"/>
          <role rolename="Everyone"/>
          <user username="dirigible" password="dirigible" roles="Developer,Operator,Everyone"/>
      </tomcat-users>
      
    3. Copy the XSK's ROOT.war to $TOMCAT/webapps folder.

    4. Provide the Java 8 JRE/JDK path.

      export JAVA8_HOME=<pathToJava8>
      

      Note

      Replace the <pathToJava8> placeholder with the actual path to your Java 8 installation (e.g. /usr/lib/jvm/java-8-openjdk-amd64/).

    5. Configure connection to HANA Cloud instance.

      export HANA_DRIVER=com.sap.db.jdbc.Driver
      export HANA_URL=jdbc:sap://<hanaHost>?encrypt=true&validateCertificate=true
      export HANA_USERNAME=<hanaUsername>
      export HANA_PASSWORD=<hanaPassword>
      

      Note

      • Replace the <hanaHost> placeholder with the HANA Cloud host that you're going to use.
      • Replace the <hanaUsername> placeholder with the HANA Cloud username that you're going to use.
      • Replace the <hanaPassword> placeholder with the HANA Cloud password that you're going to use.
    6. Start the Tomcat server.

    XSK versions

    Instead of using the latest tag (version), for production and development use cases it is recommended that you use a stable release version:

    • You can find all released versions here.
    • You can find all XSK Docker images and tags (versions) here.
  2. Open a web browser and go to: http://localhost:8080/

    Note

    The default user name and password are dirigible/dirigible.

  3. Stop the container:

    docker stop dirigible