Differences

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

--- treelets [2019/12/12 16:22] – [Verify your Treelets installation] pezik
+++ treelets [2019/12/23 10:40] – [Docker Installation] madamczyk
@@ Line 1: / Line 1: @@
 ====== 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:
-===== Docker Installation =====
+  * 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
-Detailed instruction on how to install Treelets in a Docker container.
+Any issues related to Treelets should be reported to the contact[at]pelcra.pl.
-===== Learning Outcomes =====
-  * By the end of this tutorial you will:
-  * Have a configured local Treelets web application on one machine
-  * Learned how to understand and configure Treelets Docker configuration including api, database, angular, nginx etc.
-  * Search Indexed data in Your application
-Any issues with this tutorial should be reported to the contact[at]pelcra.pl list.
-===== Requirements =====
+===== Docker Installation =====
-  * Unix environment, Windows 10 Home or Professional, Mac OS environment
-  * Docker Desktop for Windows 10 Professional or Mac OS
-  * Docker Toolbox on Windows 10 Home
-===== Install Treelets on Ubuntu =====
+Treelets can be installed locally as a Docker container on any major operating system. The installation process varies for different operating systems. The following pages explain how to install Treelets on:
-==== 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 ====
+  * [[Ubuntu 18.04/19.10]]
-  * Download treelets-docker application for Ubuntu [[Link to Treelets Docker application for Ubuntu!]]
+  * [[Linux Mint]]
-  * Unzip
+  * [[MacOS 10.15 Catalina]]
-  * Run bash and go inside treelets-docker catalog
+  * [[Windows 10 Professional]]
+  * [[Windows 10 Home]]
-==== 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 ====
+===== Requirements =====
-  * Install the application using the tutorial: [[https://docs.docker.com/toolbox/toolbox_install_windows/]]
+  * Unix environment, Windows 10 Home or Professional, MacOS environment
+  * Docker Desktop for Windows 10 Professional or MacOS
-==== Setup Treelets from a binary distribution ====
+  * Docker Toolbox on Windows 10 Home
-  * Download treelets-docker application for Windows 10 Home [[Link to Treelets Docker application for Windows 10 Home!]]
-  * 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 =====
+===== Useful Docker commands =====
 <code>