Follow this link if you are using ---> Aspire for Elasticsearch <---
The following tutorial gets you started with Aspire in 20 minutes or less.
This tutorial is for Aspire 3 (Hawthorn).
See another quick start tutorial for how to build Aspire distributions from scratch using Maven prototypes and Maven component repositories. Aspire Quick Start with Distribution Archetype
There are also tutorials for each type of connector application you might wish to install; those are located under the section for each Connector.
Anchor | ||||
---|---|---|---|---|
|
Before you begin, you need to be registered to use Aspire (go to http://aspire.searchtechnologies.com/) if you haven't already done that.
You will need your user registration name and password in order to complete this tutorial.
Note |
---|
This tutorial assumes the user has already set up his environment, if not please refer to Prerequisites |
Anchor | ||||
---|---|---|---|---|
|
Download and unpack https://wiki.searchtechnologies.com/binaries/. Select the most recent Aspire binary (aspire-distribution-X.X.zip). For purposes of this tutorial, we'll use "aspire-quick-start" as the directory name to which you unpack Aspire.
Note: This is the best way to evaluate Aspire with or without premium connectors. The preferred method if you are actually building a distribution is to use the Distribution Archetype, which requires also downloading a Maven client.
The download will create a directory structure similar to that described in Directory Structure.
Anchor | ||||
---|---|---|---|---|
|
If you haven't installed MongoDB yet, do it now: Install MongoDB 3.X
Make sure your MongoDB server is running by executing:
Code Block | ||
---|---|---|
| ||
> mongo MongoDB shell version: 4.0.4 connecting to: test > |
If it returns a "NETWORK Failed to connect to 127.0.0.1:27017" error, it means it is not running, start it by executing:
Open a terminal and CD to your MongoDB installation folder and execute:
Code Block | ||
---|---|---|
| ||
C:\Program Files\MongoDB\Server\4.0\bin> mongod |
Code Block | ||
---|---|---|
| ||
$ sudo service mongod start |
Anchor | ||||
---|---|---|---|---|
|
Go to the directory where you unpacked Aspire (such as "aspire-quick-start") and go to the configuration directory /config. Open the settings.xml file with a text or XML editor. Look for the maven repository tag. You need to replace the user name and password that displays with the user name and password you used to register for Aspire.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<repositories> <defaultVersion>4.0</defaultVersion> <repository type="distribution"> <directory>bundles/aspire</directory> </repository> <repository type="maven"> <remoteRepositories> <remoteRepository> <id>stPublic</id> <url>http://repository.searchtechnologies.com/artifactory/public/</url> <user>YOUR-REGISTERED-USERNAME</user> <password>YOUR-REGISTERED-PASSWORD</password> </remoteRepository> </remoteRepositories> </repository> </repositories> |
After you've entered your user name and password, Save and close the file. Make sure you save it so it remains an .xml file!
Also uncomment the following section and point to the server where you installed MongoDB, in this case we have MongoDB running in the same server as Aspire:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<!-- noSql database provider for the 4.0 connector framework --> <noSQLConnectionProvider sslEnabled="false" sslInvalidHostNameAllowed="false"> <implementation>com.searchtechnologies.aspire:aspire-mongodb-provider</implementation> <servers>localhost:27017</servers> </noSQLConnecitonProvider> |
Anchor | ||||
---|---|---|---|---|
|
First, make sure you have access to the internet so that Aspire can download components.
To start Aspire follow these steps:
Windows
Code Block | ||
---|---|---|
| ||
> startup.bat |
Linux or OS X
Code Block | ||
---|---|---|
| ||
$ startup.sh |
Excerpt Include | ||||||
---|---|---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Browse to: http://localhost:50505 if you are running Aspire locally or change the host to the server hosting Aspire. For details on using the Aspire Content Source Management page, please refer to Use the Aspire Admin User Interface Admin UI Audit Logs.
Anchor | ||||
---|---|---|---|---|
|
To specify exactly what File System folder to crawl, we will need to create a new "Content Source".
To create a new content source:
In the "General" tab in the Content Source Configuration window, specify basic information for the content source:
After selecting a Scheduled, specify the details, if applicable:
In the "Connector" tab, specify the connection information to crawl the File System folder.
In the "Workflow" tab, specify the workflow steps for the jobs that come out of the crawl. Drag and drop rules to determine which steps should an item follow after being crawled. This rules could be where to publish the document or transformations needed on the data before sending it to a search engine. See Workflow for more information.
After completing this steps click on the Save then Done and you'll be sent back to the Home Page.
Info |
---|
You can add more schedules by clicking in the Add New option, and rearrange the order of the schedules. |
Info |
---|
If you want to disable the content source just unselect the the "Enable" checkbox. This is useful if the folder will be under maintenance and no crawls are wanted during that period of time. |
Note |
---|
Real Time and Cache Groups crawl will be available depending of the connector. |
Anchor | ||||
---|---|---|---|---|
|
Now that the content source is set up, the crawl can be initiated.
The status will show RUNNING while the crawl is going, and CRAWLED when it is finished.
If there are errors, you will get a clickable "Error" flag that will take you to a detailed error message page.
Congratulations!!
You have completed the 20-minute quick start. We hope it was a fun experience.
To shutdown Aspire, go to the Debug Console page (http://localhost:50505/aspire) and click on the "Shutdown" button (that's the red button to the right of the server name). Or, you could go to the Aspire console window (where you started Aspire with "bin\startup") and type "shutdown" and then press the Return or Enter key. Either way will shut down Aspire.
Cheers!
The Aspire Development Team