Bitnami Apache Solr Virtual Machine

Description

Apache Solr is an extremely powerful, open source enterprise search platform built on Apache Lucene. It is highly reliable and flexible, scalable, and designed to add value very quickly after launch.

First steps with the Bitnami Apache Solr Stack

Welcome to your new Bitnami application! This guide includes some basic information you will need to get started with your application.

How to import a Bitnami Virtual Machine?

Check the following instructions to import a Bitnami Virtual Machine:

Importing a Bitnami Virtual Machine in VirtualBox
  • Select the "File -> Import Appliance" menu option and select the .ova file downloaded from the Bitnami website. Then click "Continue".
  • Once it is imported, click the "Start" button in the VirtualBox toolbar.

For a detailed walkthrough, check our Virtualbox tutorial.

Importing a Bitnami Virtual Machine in a VMware product
  • Select the "File -> Import" menu option and select the .ova file downloaded from the Bitnami website. Then click "Continue".
  • Once the import is complete, click "Finish" to start the virtual machine.

For a detailed walkthrough, check our VMware tutorial, which uses VMware Fusion as an example. To learn how to use our virtual machines with other VMware products, refer to the VMware Workstation documentation or the VMware vSphere documentation.

What credentials do I need?

You need two sets of credentials:

  • The application credentials, consisting of a username and password. These credentials allow you to log in to your new Bitnami application.
  • The server credentials, consisting of an SSH username and password. These credentials allow you to log in to your virtual machine using an SSH client and execute commands at the virtual machine console using the command line.

What is the administrator username set for me to log in to the application for the first time?

Username: user

What is the administrator password?

Password: The administrator password to log in to your application is randomly generated during the first boot. Check the FAQ to learn how to retrieve it.

What SSH username should I use for secure shell access to my application?

SSH username: bitnami

What is my server IP address?

The IP address is displayed on screen at the end of the boot process, but you can check it at any time by running the following command:

  $ sudo ifconfig

Check server IP address

How do I get my SSH key or password?

You can obtain the SSH password from the virtual machine console when it starts up. Click here for more information.

How to start or stop the services?

Each Bitnami stack includes a control script that lets you easily stop, start and restart services. The script is located at /opt/bitnami/ctlscript.sh. Call it without any service name arguments to start all services:

$ sudo /opt/bitnami/ctlscript.sh start

Or use it to restart a single service, such as Apache only, by passing the service name as argument:

$ sudo /opt/bitnami/ctlscript.sh restart apache

Use this script to stop all services:

$ sudo /opt/bitnami/ctlscript.sh stop

Restart the services by running the script without any arguments:

$ sudo /opt/bitnami/ctlscript.sh restart

Obtain a list of available services and operations by running the script without any arguments:

$ sudo /opt/bitnami/ctlscript.sh

What are the default ports?

A port is an endpoint of communication in an operating system that identifies a specific process or a type of service. Bitnami stacks include several services or servers that require a port.

IMPORTANT: Making this application's network ports public is a significant security risk. You are strongly advised to only allow access to those ports from trusted networks. If, for development purposes, you need to access from outside of a trusted network, please do not allow access to those ports via a public IP address. Instead, use a secure channel such as a VPN or an SSH tunnel. Follow these instructions to remotely connect safely and reliably.

Port 22 is the default port for SSH connections.

Bitnami opens some ports for the main servers. These are the ports opened by default: 80, 443.

How to get started with Solr?

NOTE: Replace the CORE-NAME and PORT-NUMBER placeholders in the commands below with actual values.

To create a core, use these commands:

$ cd /opt/bitnami/apache-solr
$ sudo ./bin/solr create -c CORE-NAME -p PORT-NUMBER

To add documents, use these commands:

$ cd /opt/bitnami/apache-solr
$ sudo ./bin/post -c CORE-NAME FILES

How to access the Apache Solr server console?

For security reasons, the Apache Solr server console will be accessible only when using 127.0.0.1 as the hostname. To access the server console, it is necessary to create an SSH tunnel by forwarding port 8983 on the Apache Solr server to port 8983 on the local host.

An example of configuring the SSH tunnel using PuTTY on Windows is displayed below.

PuTTY tunnel config

While the tunnel is active, you should be able to access the server console through the secure SSH tunnel you created, by browsing to http://127.0.0.1:8983/solr/admin.

Refer to the FAQ for platform-specific instructions to create the SSH tunnel.

How to connect to Apache Solr from a different machine?

For security reasons, the Apache Solr ports in this solution cannot be accessed over a public IP address. To connect to Apache Solr from a different machine, you must open port 80, 443 for remote access. Refer to the FAQ for more information on this.

IMPORTANT: Making this application's network ports public is a significant security risk. You are strongly advised to only allow access to those ports from trusted networks. If, for development purposes, you need to access from outside of a trusted network, please do not allow access to those ports via a public IP address. Instead, use a secure channel such as a VPN or an SSH tunnel. Follow these instructions to remotely connect safely and reliably.

How to configure the Apache Solr server?

Obtain example configuration files by following these steps:

$ sudo /opt/bitnami/ctlscript.sh stop solr
  • Change directories to locate the files:

      $ cd /opt/bitnami/apache-solr
    
  • Create Solr home directory /opt/bitnami/apache-solr/example/techproducts/solr by executing the following command:

      $ sudo ./bin/solr -e techproducts
    

This action creates a set of example configuration files in /opt/bitnami/apache-solr/example/techproducts/solr/techproducts/conf. These are configuration references. Modify these files depending on your server requirements.

  • Access the Solr administration interface via SSH or by opening the port 8983 in the server firewall. Refer to the FAQ for more information on how to configure your server firewall.

How can I run a command in the Bitnami Apache Solr Stack?

Log in to the server console as the bitnami user and run the command as usual. The required environment is automatically loaded for the bitnami user.

How to create a full backup of Apache Solr?

Backup

The Bitnami Apache Solr Stack is self-contained and the simplest option for performing a backup is to copy or compress the Bitnami stack installation directory. To do so in a safe manner, you will need to stop all servers, so this method may not be appropriate if you have people accessing the application continuously.

Follow these steps:

  • Change to the directory in which you wish to save your backup:

      $ cd /your/directory
    
  • Stop all servers:

      $ sudo /opt/bitnami/ctlscript.sh stop
    
  • Create a compressed file with the stack contents:

      $ sudo tar -pczvf application-backup.tar.gz /opt/bitnami
    
  • Restart all servers:

      $ sudo /opt/bitnami/ctlscript.sh start
    

You should now download or transfer the application-backup.tar.gz file to a safe location.

Restore

Follow these steps:

  • Change to the directory containing your backup:

      $ cd /your/directory
    
  • Stop all servers:

      $ sudo /opt/bitnami/ctlscript.sh stop
    
  • Move the current stack to a different location:

      $ sudo mv /opt/bitnami /tmp/bitnami-backup
    
  • Uncompress the backup file to the original directoryv

      $ sudo tar -pxzvf application-backup.tar.gz -C /
    
  • Start all servers:

      $ sudo /opt/bitnami/ctlscript.sh start
    

If you want to create only a database backup, refer to these instructions for MySQL and PostgreSQL.

How to enable the Apache Solr logs?

The Apache Solr log files are not enabled by default after version 3.x. To enable the log files, uncomment the following section in the /opt/bitnami/apache-solr/server/etc/jetty.xml file. Remember to restart the server for your changes to take effect.

<Ref id="Handlers">
  <Call name="addHandler">
    <Arg>
      <New id="RequestLog" class="org.eclipse.jetty.server.handler.RequestLogHandler">
        <Set name="requestLog">
          <New id="RequestLogImpl" class="org.eclipse.jetty.server.NCSARequestLog">
            <Set name="filename">
               logs/request.yyyy_mm_dd.log
            </Set>
            <Set name="filenameDateFormat">yyyy_MM_dd</Set>
            <Set name="retainDays">90</Set>
            <Set name="append">true</Set>
            <Set name="extended">false</Set>
            <Set name="logCookies">false</Set>
            <Set name="LogTimeZone">UTC</Set>
          </New>
        </Set>
      </New>
    </Arg>
  </Call>
</Ref>
virtualMachine

Bitnami Documentation