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 4.0 (Hawthorn).
Tip |
---|
Make sure that the Aspire version you download matches your tutorial version. The released binaries must match the training versions. |
You will install simply to You'll get build Aspire distributions from scratch using Maven prototypes and Maven component repositories Quick Start with Distribution Archetype quick start tutorial connector ; On this page:
Related pages:
Aspire Quick Start with Distribution ArchetypeStep 1: Before be registered to http://aspire.searchtechnologies.com/) if you haven't already done that registration and in This tutorial assumes you have already set up your environment. If not, see the Prerequisites. |
Anchor |
---|
quickstart | quickstart | Step 2: Download the Aspire quick start distributionStep 1: Download with Pre-Built Binaries
You must be registered to access the binaries download page. Go to How to Access Aspire , to check the Aspire Registration process.
- 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. If you are actually building a distribution, the preferred method is to use the Distribution Archetype, which requires downloading a Maven client.
The download will create a directory structure similar to that described in Directory Structure.Step
32: Start MongoDB
- If you haven't installed MongoDB yet, do it now: Install and Configure MongoDB 3.X MongoDB - Installing and Configuring a Crawl Status Database
- Make sure your MongoDB server is running by executing:
Code Block |
---|
|
> mongo
MongoDB shell version: 4.0.4
connecting to: test
> |
Error
If a "NETWORK Failed to connect to 127.0.0.1:27017" error occurs, then it is not running.
Start it by executing:
For Windows:
Open a terminal and CD to your MongoDB installation folder and execute:
Code Block |
---|
|
C:\Program Files\MongoDB\Server\4.0\bin> mongod |
For Linux:
Code Block |
---|
|
$ sudo service mongod start |
Step
43: Edit the Aspire config/settings.xml
fileFile
- Go to the directory where you unpacked Aspire (such as "aspire-quick-start").
- Go to the configuration directory /config.
- Open the settings.xml file with a text or XML editor.
- Look for the maven repository the clusterId tag.
You need to specify a cluster Id, we recommend to replace the
username and password that displays with the username and password you used to register for Aspire. dev in the settings.xml with your unique cluster id
46
<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> |
<!-- By default all Aspire servers start in their own cluster. To make servers work together, set a common
cluster id across multiple instances that are connected to a common zooKeeper instance and database
provider (for example "dev" or "prod") -->
<clusterId>dev</clusterId> |
Tip |
---|
If you encounter Parsing Error: org.xml.sax.SAXParseException: Content is not allowed in prolog This error is caused by the presence of a byte-order mark (BOM) at the start of your XML file. You can see the BOM using "od -c <filename>". Remove the BOM by copying and pasting the entire file contents to a new file in a text editor (since the BOM does not copy to the clipboard). |
You may also need to edit the settings if you are running MongoDB on a separate machine.
6. After you've entered your username and password, Save and close the file. Make sure you save it so it remains an .xml file!
7. - Modify the following section and point to the server where you installed MongoDB. In this case, MongoDB is running in the host called mongodb-host:
Excerpt Include |
---|
| MongoDB Settings |
---|
| MongoDB Settings |
---|
|
Anchor |
---|
| StartupAspire |
---|
| StartupAspire |
---|
|
Step
54: Start
up Aspire
First, make sure you have access to the internet so that Aspire can download components from our Maven repository.
To start Aspire, follow these steps:
- Open a terminal and cd to the bin/ directory inside the downloaded Aspire Distribution.
- Execute the startup script
Linux
OS X (this command must be executed from Aspire home directory)
Code Block |
---|
|
$ bin/aspire.sh |
Error
If you are unable to start Aspire and an error occurs, try accessing a URL via the browser and logging in with your registered username/password. For example:
Excerpt Include |
---|
| Aspire Quick Start with Distribution Archetype |
---|
| Aspire Quick Start with Distribution Archetype |
---|
nopanel | true |
---|
|
Step
65:
Browse to the content source management pageLaunch the Aspire Content Source Manager
- 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 Admin UI Audit Logs.
Step
76: Add a
new content sourceNew Content Source
7a FileSystem Content To specify exactly what File System folder to crawl, we will Image Removed
new 3 Home 7bImage Removed 7cImage Removed 7dImage Removed Note |
Real Time and Cache Groups crawl will be available depending of the connector. 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 clear the the Enable checkbox. This is useful if the folder will be under maintenance and no crawls are wanted during that period of time. |
8Image Removed crawl can be initiatedImage Removed 9: Congratulate yourself! (and shutdown)8: Shut Down Aspire
Congratulations
!! You have completed the 20-minute quick start.
We hope it was a fun experience.Image Removedthat'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 - Type shutdown.
- Press Return or Enter.
Image RemovedImage Added