{"componentChunkName":"component---node-modules-carrotsearch-gatsby-theme-apidocs-templates-documentation-page-js","path":"/installation/","result":{"data":{"html":{"frontmatter":{"id":"installation","title":"Installation"},"html":"
\n

Installation

\n\n

\n This article outlines Lingo3G software requirements, installation steps and\n the license file location mechanism.\n

\n\n
\n

\n Requirements\n

\n\n
\n
License file
\n
\n You need a valid license file to download and run Lingo3G. To get a\n trial license or recover a license you purchased, contact us at\n info@carrotsearch.com.\n
\n\n
Java 11 or later
\n
\n Lingo3G requires Java 11 or later. If you don't have Java installed on\n your system, you can get it from\n https://adoptopenjdk.net.\n
\n\n
Operating System
\n
\n Lingo3G works on any modern operating system that supports Java 11 or\n later, including Windows, Linux or Mac OS.\n
\n\n
Web browser
\n
\n

\n Lingo3G apps require a modern browser, such as the latest version of\n Chrome, Firefox, Safari or Edge.\n

\n\n

Internet Explorer is not supported.

\n
\n
\n
\n\n
\n

\n Installation\n

\n\n

To install Lingo3G on your machine, perform these steps:

\n\n
    \n
  1. \n

    \n Verify if Java 11 or later is available on your system by running the\n following command:\n

    \n\n
    \n 
    java -version\n
    \n
    \n\n

    \n If Java 11 or later is available, the output should be similar to:\n

    \n\n
    \n 
    openjdk version \"11.0.9\" 2020-10-20\nOpenJDK Runtime Environment AdoptOpenJDK (build 11.0.9+11)\nOpenJDK 64-Bit Server VM AdoptOpenJDK (build 11.0.9+11, mixed mode)\n
    \n
    \n\n

    \n If Java 11 is not available on your system, you can get the\n installation package from\n https://adoptopenjdk.net.\n

    \n
    2. \n\n
  2. \n

    \n Go to\n secure.carrotsearch.com\n and download Lingo3G version 2.0.0 or later.\n

    \n
    3. \n\n
  3. \n

    Unpack the archive to a local folder.

    \n
    4. \n\n
  4. \n

    \n Copy your license file (the ZIP archive or the XML license file inside\n the ZIP) to the\n dcs/conf folder inside the Lingo3G folder.\n

    \n\n

    \n Sometimes it may be convenient to keep the license file at a different\n location, such as the user's home directory. See\n License file locations\n for the list of possibilities.\n

    \n
    5. \n
\n\n

\n Now you are ready to run the\n Clustering Workbench app and\n the REST API. The Java API requires\n additional\n setup steps.\n

\n
\n\n
\n

\n License\n

\n\n

\n You need a valid license to download and run Lingo3G. To get an evaluation\n license or recover a license you purchased, contact us at\n info@carrotsearch.com.\n

\n\n

\n The license is a plain-text unicode string. We distribute licenses as XML\n files following the license*.xml naming convention. The\n license file can be compressed with ZIP, but the resulting archive must\n contain exactly one file (the license) inside the archive. (We e-mail\n license files inside ZIP archives because some spam filters block XML\n attachments.)\n

\n\n

\n To validate a license file, upload it at\n secure.carrotsearch.com. The\n validator shows when your license expires (you will not be able to use the\n software beyond that date) and when software maintenance expires (you will\n not be able to upgrade to versions released after that date). The\n validator also lets you download all the products covered by the license\n file.\n

\n\n
\n \n
\n \n \"Carrot\n
\n \n
\n

\n Carrot Search license validator\n showing contents of a license file along with software download links.\n

\n
\n
\n\n
\n

\n License file locations\n

\n\n

\n To perform clustering, Lingo3G must be able to read the license file at\n runtime. Lingo3G attempts to read the license from a number of\n locations. The specific locations are different for the Java API and the\n Document Clustering Server.\n

\n\n
\n

\n Document Clustering Server\n

\n\n

\n Document Clustering Server scans the following locations for license\n files:\n

\n\n
    \n
  1. \n

    \n If you pass license string in the\n license\n request parameter, Lingo3G will use it.\n

    \n
    2. \n\n
  2. \n

    \n DCS attempts to read the license from all files matching thelicense*.(xml|zip)\n pattern under the dcs/conffolder. We recommend this\n location for installing the license file in the DCS.\n

    \n
    3. \n\n
  3. \n

    \n If you define the LICENSE_LINGO3G environment\n variable to point to an accessible file or directory, Lingo3G will\n scan that location for any files matching the\n license*.(xml|zip) pattern. Lingo3G will try to find\n a valid license among all matching files.\n

    \n
    4. \n\n
  4. \n

    \n If user.home system property is accessible and points\n to a readable folder, Lingo3G will scan that location for any\n files matching the license*.(xml|zip)\n pattern. Lingo3G will try to find a valid license among all\n matching files.\n

    \n
    5. \n
\n
\n\n
\n

\n Java API\n

\n\n

\n Lingo3G Java API uses the following steps to determine which license\n to use for processing the request. Once Lingo3G finds a valid license,\n it does not check further locations.\n

\n\n
    \n
  1. \n

    \n If you pass license string in the\n \n license\n parameter, Lingo3G will use it.\n

    \n
    2. \n\n
  2. \n

    \n If you define the LICENSE_LINGO3G environment\n variable to point to an accessible file or directory, Lingo3G will\n scan that location for any files matching the\n license*.(xml|zip) pattern. Lingo3G will try to find\n a valid license among all matching files.\n

    \n
    3. \n\n
  3. \n

    \n If user.home system property is accessible and points\n to a readable folder, Lingo3G will scan that location for any\n files matching the license*.(xml|zip)\n pattern. Lingo3G will try to find a valid license among all\n matching files.\n

    \n
    4. \n\n
  4. \n

    \n If you make available a resource called\n license.xml loadable via the class loader of the\n \n Lingo3GClusteringAlgorithm\n class, Lingo3G will attempt to read the license from that\n resource.\n

    \n
    5. \n\n
  5. \n

    \n If you provide any custom\n \n LicenseLocationSupplier\n service loader implementations, Lingo3G will use them to look up\n licenses.\n

    \n
    6. \n
\n\n

\n During software development, it is most convenient to copy the license\n file into your home directory. In production, we recommend creating a\n custom license location supplier extension that will provide the\n license location to Lingo3G. You can find an an example of this\n approach in the\n elasticsearch-lingo3g\n extension plugin for Elasticsearch.\n

\n
\n
\n
\n
","tableOfContents":[{"heading":"Requirements","anchor":"requirements"},{"heading":"Installation","anchor":"installation"},{"heading":"License","anchor":"license","sections":[{"heading":"License file locations","anchor":"license-file:locations","sections":[{"heading":"Document Clustering Server","anchor":"license-file:locations:dcs"},{"heading":"Java API","anchor":"license-file:locations:java-api"}]}]}]}},"pageContext":{"slug":"/installation/"}},"staticQueryHashes":["1164750013"]}