Installing Aspire with this approach is NOT production recommended, though it can be used as an accelerator for production deployments


  • Docker 20.10.X and up.
    • If using MacOS or Windows, install Docker Desktop
  • Resources for MacOS/Windows Docker Desktop
    • Docker Desktop → Preferences → Resources → Advanced
      • 2 CPUs
      • 8 GB Memory
  • A valid Aspire account and Aspire 5 License (see Aspire Registration and Licensing)
  • Download

Installation Process

  1. Unzip the file
  2. (If MacOS or Windows) Install Docker Desktop from the Official Site
    1. Set the resources for Docker Desktop as to at least 2 CPUs, 8 GB Memory, 1 GB Swap (at Preferences → Resources → Advanced)
    2. Enable file sharing on the unziped aspire-quickstart folder (at Preferences → Resources → File Sharing)
  3. Open a command line terminal and Login to artifactory docker registry:

    $ docker login

    You will be prompted for your credentials (registered email and password)

    If you can't remember the credentials, write to [email protected], these would be shared with you when you request the Account and License. This step is required, so Docker can download the official images of Aspire.
  4. Copy your AspireLicense.lic to aspire-quickstart/config/
    1. Only Aspire 5 Licenses are valid
  5. Execute installation script from command line terminal:
    1. if MacOS or Linux
      1. On Linux, before executing the script, give it execution permissions: chmod +x
    2. install-quickstart.bat if Windows
  6. Wait until all containers have started:

It may take several minutes for Aspire to download all the required components and start.

Now you should be able to access aspire at: https://localhost:50443/

Login with admin1 / 123456abC

Happy crawling with Aspire5!

Accessing using browser

The quick-start installation script does not make use of real HTTPS certificates, rather it creates and self-sign one for each service, as it was designed to provide a DEMO installation only. Do NOT expose these services publicly or use them in production environments.

Many web browsers don't allow opening sites with untrusted certificates. We recommend using Firefox or Chrome to interact with the services. You will be warned that you are about a get into a "Potencial Security Risk", which is expected due to the untrusted nature of these certificates, just click on Accept the Risk And Continue.

If using Chrome on Mac, open chrome using the following command line command:

Applications/Google\\ Chrome --ignore-certificate-errors --ignore-urlfetcher-cert-requests &> /dev/null

Untrusted certificates warning

After "Accepting the Risk and Continue"

Uninstall quick-start containers

  1. Execute if MacOS or Linux
    1. uninstall-quickstart.bat if Windows

What has been installed with these scripts?

The current quick-start guide installs the following containers:

Want to know more about the quick-start?

The current quick-start scripts execute the following steps in order:

  1. Creates docker volumes for persistent storage (Elasticsearch indexes, SSL certificates, LDAP directory) and network for all the containers to communicate to each other
  2. Generates self-signed certificates and CA for Elasticsearch, Kibana and Aspire nodes (see generate-ssl.[sh/bat])
    1. Copies the certificates to the docker volumes previously created
    2. If you want to do this for an on-premise installation, follow Enable HTTPS
  3. Starts Elasticsearch and Kibana
    1. The elasticsearch/docker-compose.yml contains a service that runs once to upload the Kibana Dashboard at elasticsearch/export.ndjson
    2. Uses the certificate docker volumes to obtain and configure the certificates
  4. Uploading of settings and Aspire License to Elasticsearch (see update-settings-license.[sh/bat])
    1. Uses the same aspire docker image to do it, the same env properties are provided for the Elasticsearch authentication and SSL certificate trusting.
  5. Starts the LDAP service
    1. Copies the LDIF folder with preloaded configuration into the LDAP directory docker volume
    2. Starts the ldap/docker-compose.yml
  6. Starts Aspire service using aspire/docker-compose.yml

All docker containers share the same environment variables in the .env file, this is not recommended for production deployments, but simplifies the management of variables for the quick-start scripts.