Group

User Tools

Site Tools

Trace:
treelets

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
treelets [2019/12/16 10:32] – peziktreelets [2019/12/26 00:55] (current) – [Docker Installation] pkowalczyk
Line 1: Line 1:
 ====== Treelets Documentation ====== ====== Treelets Documentation ======
  
-This page contains the documentation of the Treelets phraseology extraction tool. +This page contains the documentation of the Treelets phraseology extraction tool. The main topics covered here include:
  
-The main topics covered here include: +  * Configuring and running the Treelets docker container including the Postgres database, Java API, angular web application, nginx server etc.
- +
-  * Configuring and running the Treelets docker container, which includes the Postgres database, Java API, angular web application, nginx server etc.+
   * Parsing and indexing corpora, generating and searching automatic combinatorial dictionaries extracted with Treelets   * Parsing and indexing corpora, generating and searching automatic combinatorial dictionaries extracted with Treelets
  
 Any issues related to Treelets should be reported to the contact[at]pelcra.pl. Any issues related to Treelets should be reported to the contact[at]pelcra.pl.
- 
  
 ===== Docker Installation ===== ===== Docker Installation =====
  
-Treelets can be installed locally as a Docker container on any major operating system.  +Treelets can be installed locally as a Docker container on all major operating systems. The installation process varies for different operating systems. The following pages explain how to install Treelets on:
- +
-The installation process varies for different operating systems. The following pages explain how to install Treelets on:+
  
   * [[Ubuntu 18.04/19.10]]   * [[Ubuntu 18.04/19.10]]
   * [[Linux Mint]]   * [[Linux Mint]]
-  * [[Mac OS 10.15 Catalina]]+  * [[MacOS 10.15 Catalina]]
   * [[Windows 10 Professional]]   * [[Windows 10 Professional]]
   * [[Windows 10 Home]]   * [[Windows 10 Home]]
- 
- 
  
 ===== Requirements ===== ===== Requirements =====
-  * Unix environment, Windows 10 Home or Professional, Mac OS environment +  * Linux environment, Windows 10 Home or Professional or MacOS environment 
-  * Docker Desktop for Windows 10 Professional or Mac OS+  * Docker Desktop for Windows 10 Professional or MacOS
   * Docker Toolbox on Windows 10 Home   * Docker Toolbox on Windows 10 Home
  
-===== Install Treelets on Ubuntu ===== +===== Useful Docker commands =====
-==== Install Docker ==== +
-  * # run in Linux bash install commands: +
-<code> +
-sudo apt install docker  +
-sudo apt install docker-compose  +
-sudo apt install postgresql-client-common +
-</code> +
-  * # check docker version commands: +
-<code> +
-sudo docker -v  +
-sudo docker-compose -v +
-</code> +
- +
-==== Setup Treelets from a binary distribution ==== +
-  * Download treelets-docker application for Ubuntu {{ :treeletsdocker_ubuntu_2019_12_10.zip |}} +
-  * Unzip +
-  * Run bash and go inside treelets-docker catalog +
- +
-==== Run Docker ==== +
-  * # run in Linux bash commands: +
-<code> +
-# Build +
-sudo docker-compose build +
-         +
-# Running +
-sudo docker-compose up -d +
-         +
-# View instances +
-sudo docker-compose ps +
-</code> +
- +
-===== Install Treelets on Windows 10 Home ===== +
- +
-==== Install Docker Toolbox ==== +
-  * Install the application using the tutorial: [[https://docs.docker.com/toolbox/toolbox_install_windows/]] +
- +
-==== Setup Treelets from a binary distribution ==== +
-  * Download treelets-docker application for Windows 10 Home {{ ::treeletsdocker_w10home_2019_12_08.zip |}} +
-  * Unzip +
-  * Run Docker Quickstart Terminal from Desktop and go inside treelets-docker catalog +
- +
-==== Run Docker ==== +
-  * # run in Docker Quickstart Terminal command and note ip, it will be used to open application +
-<code> +
-# get default ip for application +
-docker-machine ip default +
-</code> +
- +
-  * # using windows explorer go to the file treelets-docker\app\webapp\assets\config\api.json +
-<code> +
-# change webSocketHost address to docker-machine ip default eg. +
-"webSocketHost": "ws://192.168.99.100:4221/notifications" +
-</code> +
- +
-  * # run install commands: +
-<code> +
-# create a volume +
-docker volume create postgres_database +
- +
-# check volumes +
-docker volume ls +
- +
-# Build +
-docker-compose build +
-         +
-# Running +
-docker-compose up -d +
-         +
-# View instances +
-docker-compose ps +
-</code> +
- +
-===== Verify your Treelets installation ===== +
-  * Open your favourite Browser and type: http://localhost:8080 +
-  * On Windows 10 Home use the IP specified during installation: http://192.168.99.100:8080 +
- +
- +
-===== Docker useful commands =====+
  
 <code> <code>
Line 128: Line 43:
 exit exit
                  
-# Stop+# Stop docker containers
 sudo docker-compose stop sudo docker-compose stop
                  
-# Remove+# Remove docker containers
 sudo docker-compose down sudo docker-compose down
 </code> </code>
- 
- 
- 
- 
- 
- 
- 
treelets.1576492353.txt.gz · Last modified: 2019/12/16 10:32 by pezik