This guide describes how to install Axional Docs

 

1 Requeriments

To startup a server a minimum software should be installed in the guest Linux computer

  1. A Linux operating system with at least 2 GB of RAM.
  2. The internet connection must be enabled due the files are downloaded from an external repository.
It may be necessary to install the fontconfig Linux package to be able to use the ditaa graph renderization (check this article for examples). You can use the common package managers to install it:
Copy
yum intall fontconfig
 

1.1 Java

A Java 8 SE machine is required to run the application.

Run the following command in a terminal to check the current Java version:

Copy
$ java -version

If Java is already installed, you can see a similar result like:

Copy
$ java -version
java version "1.8.0_25"
Java(TM) SE Runtime Environment (build 1.8.0_25-b17)
Java HotSpot(TM) 64-Bit Server VM (build 25.25-b02, mixed mode)

If not satisfied it can be downloaded here. From command line you can use the following command:

Copy
$ curl -L -C - -b "oraclelicense=accept-securebackup-cookie" -O http://download.oracle.com/otn-pub/java/jdk/8u121-b13/e9e7ea248e2c4826b92b3f075a80e441/jdk-8u121-linux-x64.tar.gz

After Java Installation you should define JAVA_HOME environment variable pointing to your Java Install Directory. Alternatively you can define full server access to installed Java by setting up linux alternates:

Copy
# update-alternatives --install "/usr/bin/java" "java" "/opt/jdk1.8.0_102/bin/java" 1
# update-alternatives --install "/usr/bin/javac" "javac" "/opt/jdk1.8.0_102/bin/javac" 1
# update-alternatives --install "/usr/bin/javaws" "javaws" "/opt/jdk1.8.0_102/bin/javaws" 1

And then you can use the config statement to update to your prefered JVM version

Copy
# update-alternatives --config java
# update-alternatives --config javac
# update-alternatives --config javaws
 

1.2 Create an user 'docs'

We recommend to install it, in the /home/docs/axional-docs directory.

As root user, proceed to create the user docs:

Copy
$ su - root
Copy
$ useradd docs
Copy
$ passwd docs

After the user docs is created, do login with this user and create the folder where the software will be installed:

Copy
$ su - docs
Copy
$ mkdir axional-docs
Copy
$ cd axional-docs
 

1.3 Axional installer

As docs user, on the directory /home/docs/axional-docs download the installation tool using the curl command:

Copy
$ su - axs
Copy
$ curl -k -s -o "axional-install.tar.gz" "https://bitbucket.org/deister/axional-install/get/tip.tar.gz"

or, using the command wget:

Copy
$ wget -q -O "axional-install.tar.gz" "https://bitbucket.org/deister/axional-install/get/tip.tar.gz"

Extract using the "tar" command:

Copy
$ tar -x -z --strip-components=1 -f "axional-install.tar.gz"
 

2 Install the application

Firstly, use axional installer to setup remote software repository and credentials.

Yo need to ask for a nexus username and password to access deister nexus software repository

Use the shell to install the product

Copy
$ ./install.sh install
* Looking for curl...
* Looking for unzip...
* Check Java ...
  = Found java executable in PATH
  = Java version 1.8.0_91
* Looking for gradle
* Trying to download gradle 3

First time you execute the installer, it will ask for some parameters to configure installation. You need to request nexus user and password to deister support for accesing software repositories.

 

2.1 Connection details

The installer will prompt for connection parameters to the Nexus repository such as the url, user and password

================================================================
CONFIGURATION
================================================================

Nexus Base URL [http://nexus.deistercloud.com/]:
Nexus User []: UserProvided
Nexus User Password []: PassProvided
                
 

2.2 Choose product

Next the the installer will prompt for product. We will enter docs.

 

2.3 Choose the version

To start downloading a snapshot version, answer y to the question:

Do you want to download from the SNAPSHOT repository? y

Before continuing the installer will review the parameters:

CONFIGURATION PARAMETERS
--------------------------------------
NEXUS_BASE_URL: http://nexus.deistercloud.com/
NEXUSUSER.....: UserProvided
NEXUSPASS.....: ************
NEXUSPRODUCT..: docs
PRODUCTNAME...: axional.docs
PRODUCTVERS...: 0.0.+

Are You Sure? [y/n]

This questions are asked only first time and stored in file .install.rc. Following use of install.sh shell, will use parameters answered for accesing deister nexus repositories.

 

3 Configuration

The server configuration is stored in the XML file config.xml (located in the "config" folder in the application path).

 

3.1 External information

The Axional Docs application implements a mechanism to retrieve information from an Axional Studio server. The parametrization to allow getting that information is done on the cnfiguration file, node application/services. For example, it can be as follows:

<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="cmsConfig">
    ...
    <backendUrl>http://localhost:8080/soap/servlet/rpcrouter</backendUrl>
    <backendUsername>docs_user_code</backendUsername>
    <backendPassword>docs_user_password</backendPassword>
    <backendDatabase>acme_db</backendDatabase>
    ...
</application>
 

4 Notes for Windows users

  1. Get and install Cygwin to be able to use the installer: link. Take in account that some utilities like "unzip", "curl", "diff" may be usefull
  2. Get and install Java JDK 1.8: link
  3. Inside the Cygwin environment, create a link to Java folder (outside the "docs" folder):
    Copy
    mkdir docs
    cd docs
    ln -s /cygdrive/c/Program\ Files/Java/jdk1.8.0_121  ../winjava
  4. Run installer and server following the instructions on prevoius sections