Differences

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

--- treelets [2019/12/11 20:34] – [Verify your Treelets installation] pwilk
+++ treelets [2019/12/26 00:55] (current) – [Docker Installation] pkowalczyk
@@ 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:
+  * Configuring and running the Treelets docker container including the Postgres database, Java API, angular web application, nginx server etc.
+  * 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.
 ===== Docker Installation =====
-Detailed instruction on how to install Treelets in a Docker container.
+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:
-===== Learning Outcomes =====
+  * [[Ubuntu 18.04/19.10]]
-  * By the end of this tutorial you will:
+  * [[Linux Mint]]
-  * Have a configured local Treelets web application on one machine
+  * [[MacOS 10.15 Catalina]]
-  * Learned how to understand and configure Treelets Docker configuration including api, database, angular, nginx etc.
+  * [[Windows 10 Professional]]
-  * Search Indexed data in Your application
+  * [[Windows 10 Home]]
-Any issues with this tutorial should be reported to the contact[at]pelcra.pl list.
 ===== 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
-===== 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 [[Link to Treelets Docker application for Ubuntu!]]
-  * Unzip
-  * Run bash and go inside treelets-docker catalog
-==== Run Docker ====
-  * # run in Linux bash commands:
 <code>
-# Build
+# View instances with container id
-sudo docker-compose build
+sudo docker ps
-# Running
+# Logs
-sudo docker-compose up -d
+sudo docker-compose logs
-# View instances
-sudo docker-compose ps
-</code>
-===== Install Treelets on Windows 10 Home =====
+# Monitoring
+sudo docker stats
-==== Install Docker Toolbox ====
+# Connect sql command
-  * Install the application using the tutorial: [[https://docs.docker.com/toolbox/toolbox_install_windows/]]
+sudo docker exec -it {container_id} sh
+psql -U treelets treelets
-==== Setup Treelets from a binary distribution ====
+select * from info.config;
-  * Download treelets-docker application for Windows 10 Home [[Link to Treelets Docker application for Windows 10 Home!]]
+select version();
-  * Unzip
+\q
-  * Run Docker Quickstart Terminal from Desktop and go inside treelets-docker catalog
+exit
-==== 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
+# Stop docker containers
-docker-compose up -d
+sudo docker-compose stop
-# View instances
+# Remove docker containers
-docker-compose ps
+sudo docker-compose down
 </code>
-===== Verify your Treelets installation =====
-  * Open Your Favourite Browser and type: http://localhost:8080
-  * On Windows 10 Home will be on ip default: http://{docker-machine ip default}:8080 eg. http://192.168.99.100:8080
-====== Docker useful commands ======