Step 1: Download with Pre-Built Binaries
You must be registered to access the binaries download page. Go to https://aspire.searchtechnologies.com to register.
Step 2: Start MongoDB
- If you haven't installed MongoDB, do it now: Installing and Configuring a Crawl Status Database
- Make sure your MongoDB server is running by executing:
If a "NETWORK Failed to connect to 127.0.0.1:27017" error occurs, then it is not running.
Start it by executing:
Open a terminal and CD to your MongoDB installation folder and execute:
Step 3: Edit the Aspire config/settings.xml File
- 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 tag.
- You need to replace the YOUR-REGISTERED-USERNAME and YOUR-REGISTERED-PASSWORD in the settings.xml file with the username and password you used to register for Aspire.
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).
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!
You may also need to edit the settings if you are running MongoDB on a separate machine.
- If this is the case, 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:
Step 4: Start 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
OS X (this command must be executed from Aspire home directory)
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:
- Can you get to https://repository.searchtechnologies.com/artifactory/public/com/searchtechnologies/aspire/aspire-application/3.2/aspire-application-3.2.jar in a browser?
Enter the username/password that you entered inyour settings.xml file.
- Do you use a proxy?
If so, modify settings.xml to include information as described in “Proxy Settings” on the General Settings page.
The "aspire" batch script (on Windows) or shell script (on Unix) can be modified as necessary if you want to assign more memory or need to set other JVM system properties. Example output: Aspire may take a few minutes to load all of the necessary components. You will see feedback to the command prompt during the startup. 3. Use the standard administration interface (http://localhost:50505) to install pre-packaged applications such as connectors and search engine publishers. Go to Admin UI for more details. 4. If you see an error like this: and Aspire exits: 5. Check that you have the correct username and password in the config/settings.xml file. See General Settings for details. For more information on how to start, stop, install as service, see Launch Control
The "aspire" batch script (on Windows) or shell script (on Unix) can be modified as necessary if you want to assign more memory or need to set other JVM system properties.
Aspire may take a few minutes to load all of the necessary components. You will see feedback to the command prompt during the startup.
3. Use the standard administration interface (http://localhost:50505) to install pre-packaged applications such as connectors and search engine publishers.
Go to Admin UI for more details.
4. If you see an error like this:
and Aspire exits:
5. Check that you have the correct username and password in the config/settings.xml file. See General Settings for details.
For more information on how to start, stop, install as service, see Launch Control
Step 5: Launch the Aspire Content Source Manager
Step 6: Add a New Content Source
Step 6a: Add a New FileSystem Content Source
To specify exactly what File System folder to crawl, we will need to create a new "Content Source".
To create a new content source:
- From the Aspire Content Source Manager Home page, Add Source.
- Click File System Connector.
Step 6b: Specify Basic Information
In the General tab in the Content Source Configuration window, specify basic information for the content source:
- Enter a content source name in the "Name" field.
- This is any useful name which you decide is a good name for the source. It will be displayed in the content source page, in error messages, etc.
- Click on the Scheduled pull-down list and select one of the following: Manually, Periodically, Daily,Weekly or Advanced.
- Aspire can automatically schedule content sources to be crawled on a set schedule, such as once a day, several times a week, or periodically (every N minutes or hours).For the purposes of this tutorial, you may want to select Manually and then set up a regular crawling schedule later.
- Click on the Action pull-down list to select one of the following: Start, Stop, Pause, or Resume.
- This is the action that will be performed for that specific schedule.
- Click on the Crawl pull-down list and select one of the following: Incremental, Full, Real Time, or Cache Groups.
- This will be the type of crawl to execute for that specific schedule.
- This will be the type of crawl to execute for that specific schedule.
After selecting a Scheduled, specify the details, if applicable:
- Manually: No additional options.
- Periodically: Specify the "Run every:" options by entering the number of "hours" and "minutes."
- Daily: Specify the "Start time:" by clicking on the hours and minutes drop-down lists and selecting options.
- Weekly: Specify the "Start time:" by clicking on the hours and minutes drop-down lists and selecting options, then clicking on the day checkboxes to specify days of the week to run the crawl.
- Advanced: Enter a custom CRON Expression (e.g. 0 0 0 ? * *)
Step 6c: Specify the Connector Information
In the Connector tab, specify the connection information to crawl the File System folder.
- Enter the folder path you want to crawl.
- For Windows: Use the following format D:\folder\folder1\
- For Linux: Use the following format /home/user/folder/folder1/
- Check on the other options as needed:
- Index Containers?: Index containers as items. If unchecked, only files will be indexed.
- Scan Recursively?: Scan through subfolder's child nodes.
- Scan Excluded Item: It will scan sub items of container that have been excluded
- Include/Exclude patterns: Enter regex patterns to include or exclude files/folders based on URL matches.
Step 6d: Specify Workflow Information
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. These 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.
- For the purpose of this tutorial, drag and drop the Publish To File rule found under the Publishers tab to the onPublish Workflow tree.
- Specify a Name and Description for the Publisher.
- Click Add.
After completing these steps, click Save and Done and you'll be sent back to the Home page.
Step 7: Initiate the full crawl
Now that the content source is set up, you will see a box (called a 'card') on the main page which shows your new content source. You can use the buttons in this box to initiate a crawl.
- Click Full crawl (left most black circle) to initiate the crawl.
During the Crawl
- Click Refresh on the Content Sources page to view the latest status of the crawl.
The status will show RUNNING while the crawl is going, and CRAWLED when it is finished.
- Click Complete to view the number of documents crawled so far, the number of documents submitted, and the number of documents with errors.
Important: If there are errors, you will get a clickable Error that will take you to a detailed error message page.
Checking the Output
Because you are publishing the results to a file, you can see the published jobs in the file you specified when installing the "Publish To File" component. Typically this will be in the "logs" directory, in the "publishToFile.jobs" file (which can be usually be found under the "Publish_To_File" sub-directory).
Step 8: Shut Down Aspire
Congratulations! You have completed the 20-minute quick start.
- To shut down Aspire, go to the Debug Console page (http://localhost:50505/aspire).
- Click Shutdown (the red button to the right of the server name).
Or, go to the Aspire console window (where you started Aspire with "bin\startup") and
- Type shutdown.
- Press Return or Enter.