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 2, if you need a tutorial for an older version (1.x), use the link Getting Started Aspire 1.x This tutorial will take you through installing Aspire simply to It will give you you install Admin user interfaceThere is another quick start tutorial to learn how to build Aspire distributions from scratch using Maven prototypes and Maven component repositories. Quick Start with Distribution Archetype
Additionally, there are also connector wish ; those are each Connector.
You must be registered to access the binaries download page. Go to How to Access Aspire , to check the Aspire Registration process.
Anchor | ||||
---|---|---|---|---|
|
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 |
Anchor | ||||
---|---|---|---|---|
|
The version of Java you should use depends on the Aspire version you are targeting to:
Note that we recommend installing the Java JDK (Java Development Kit), just in case you want to create your own Aspire Components in the future. But really, only the JRE (Java Runtime Environment) is absolutely required.
up to Aspire 2.1.2:
Code Block |
---|
> java -version
java version "1.6.0_18"
Java(TM) SE Runtime Environment (build 1.6.0_18-b07)
Java HotSpot(TM) 64-Bit Server VM (build 16.0-b13, mixed mode)
|
or as of Aspire (2.2 Release) :
Code Block |
---|
> java -version
java version "1.7.0_79"
Java(TM) SE Runtime Environment (build 1.7.0_79-b15)
Java HotSpot(TM) 64-Bit Server VM (build 24.79-b02, mixed mode) |
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 Aspire Directory Structure.
Step 3: Edit the AspireYou need to specify a cluster Id, we recommend to replace the
dev in the settings.xml with your unique cluster id
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<!-- 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.
Excerpt Include | ||||
---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Once you've entered your user name and password, save and close the file. Make sure you save it so it remains a .xml file
Step 4: Start UpFirst, make sure you have access to the internet so that Aspire can download components . Next, still in the Aspire directory you created, change to the /bin directory and type "startup" to launch Aspire.from our Maven repository.
To start Aspire, follow these steps:
Code Block | ||
---|---|---|
| ||
> aspire.bat |
Linux
Code Block | ||
---|---|---|
| ||
$ aspire.sh |
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 | ||||||
---|---|---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Note that "startup" is a batch script (on Windows) or a shell script (on Unix) that can be modified as necessary if you need more memory or need to set other system properties.
Aspire may take a few seconds to load all of the necessary components. You will see feedback to the command prompt during the startup.
NOTE: If you are downloading Aspire Community, ignore the error message about being unable to download the com.searchtechnologies.aspire:aspire-dcm-enterprise component. The aspire-dcm-enterprise component is available only with Enterprise systems (and is used for Distributed Processing).
Launch Aspire (if it's not already running). See:
For details on using the Aspire Content Source Management page, please refer to Admin UI
IntroductionAnchor | ||||
---|---|---|---|---|
|
Congratulations!!
YouCongratulations! You have completed the 20-minute quick start.
Or,
go to the Aspire console window (where you started Aspire with "bin\startup") and
Cheers!
The Aspire Development Team