Sign inTry Free

SingleStore Studio Installation

On this page

Important

Studio is designed to work with MemSQL 6.5 or later and is only supported on Chrome and Firefox browsers at this time.

Studio is not compatible with the SingleStore Kubernetes Operator.

Studio’s monitoring capabilities have been superseded by SingleStore’s enhanced cluster monitoring solution, which is recommended for all self-managed and Kubernetes Operator customers.

Studio is not intended as a comprehensive monitoring solution and therefore lacks the features of similar third-party tools. SingleStore recommends exploring these supported third-party tools, which have been tested by SingleStore and are likely familiar to developers. These tools offer advanced features, improved performance, and specialized capabilities for managing complex database operations, and can provide increased efficiency and a smoother workflow.

Should you encounter any issues with these tools, or require further assistance, please contact SingleStore Support.

Caution

Studio should be installed on a host that is open to local (internal) network traffic only, and not open to the Internet.

Installing Studio can be done easily through the popular package managers on Debian and Red Hat-based distributions. This allows you to utilize existing workflows when installing and upgrading your Studio package.

Network Configuration

The following port setting should be enabled on the host(s) on which Studio is installed.

Protocol

Default Port

Direction

Description

TCP

8080

Inbound and Outbound

Default port for Studio. (Only required for the host running Studio.)

Red Hat Distribution

Online Installation

For online installations where you can access the SingleStore YUM repository, run the following steps.

  1. Add the SingleStore repository to your repository list.

    sudo yum-config-manager --add-repo https://release.memsql.com/production/rpm/x86_64/repodata/memsql.repo

  2. Verify that the SingleStore repo information is listed under repolist.

    sudo yum repolist

  3. Install Studio.

    sudo yum install -y singlestoredb-studio

Offline Installation

For installation in an environment without Internet access, download the following singlestoredb-studio package and install it onto your target host.

singlestoredb-studio

Install the singlestoredb-studio package using rpm.

sudo rpm -ivh /tmp/singlestoredb-studio-<version>.x86_64.rpm

Debian Distribution

Online Installation

For online installations where you can access the SingleStore APT repository, run the following steps.

  1. SingleStore packages are signed to ensure integrity, so the GPG key needs to be added to this host. When done, verify that the SingleStore signing key has been added using apt-key list.

    wget -O - 'https://release.memsql.com/release-aug2018.gpg' 2>/dev/null | sudo apt-key add - && apt-key list

    Without using apt-key:

    wget -q -O - 'https://release.memsql.com/release-aug2018.gpg' | sudo tee /etc/apt/trusted.gpg.d/memsql.asc 1>/dev/null

  2. Verify you have apt-transport-https installed.

    apt-cache policy apt-transport-https

    If apt-transport-https is not installed, you must install it before proceeding. user-shell sudo apt -y install apt-transport-https

  3. Add the SingleStore repository to retrieve its packages.

    echo "deb [arch=amd64] https://release.memsql.com/production/debian memsql main" | sudo tee /etc/apt/sources.list.d/memsql.list

  4. After verifying the SingleStore repo information is listed in the output, install SingleStore Studio.

    sudo apt update && sudo apt -y install singlestoredb-studio

Offline Installation

For installation in an environment without Internet access, download the following singlestoredb-studio package and install it onto your target machine.

singlestoredb-studio

Install the singlestoredb-studio package using dpkg.

sudo dpkg -i singlestoredb-studio_<version>_amd64.deb

Tarball

Download SingleStore Files

Download the following SingleStore tarball file onto a device with access to the main deployment host.

singlestoredb-studio

Transfer SingleStore Files

Transfer the singlestoredb-studio tarball file into a dedicated singlestore directory that has been configured so that non-sudo users can access on the main deployment host, such as /home/<user>/singlestore or /opt/singlestore.

Unpack SingleStore Files

Note: For the remainder of this document, <version>-<commit-hash> will be written simply as <version>.

Unpack singlestoredb-studio into the singlestore directory.

tar xzvf singlestoredb-studio-<version>.tar.gz

Set Up SingleStore Studio

Start Studio

Studio will now run the Studio web server on port 8080.

Package-based Installation

Start the singlestoredb-studio service.

sudo systemctl start singlestoredb-studio

Recommended: Enable the singlestoredb-studio service to start Studio after the host is rebooted.

sudo systemctl enable singlestoredb-studio.service
Created symlink /etc/systemd/system/multi-user.target.wants/memsql-studio.service → /lib/systemd/system/memsql-studio.service.

If your Linux distribution does not use systemd, you can run Studio directly. Use nohup to prevent singlestoredb-studio from terminating when you close your terminal session.

nohup sudo singlestoredb-studio > studio.stdout 2> studio.stderr < /dev/null &

Tarball-based Installation

By creating the following singlestoredb-studio.service file and enabling the singlestoredb-studio service, Studio will be restarted after the host is rebooted.

Perform the following steps on the host where Studio has been installed.

  1. Create a singlestoredb-studio.service file in the /etc/systemd/system directory.

    sudo vi /etc/systemd/system/singlestoredb-studio.service

  2. Using the following example, replace:

    • The value of User with the user under which Studio will run (typically memsql). In this example, the user is memsql.

    • The directory in the ExecStart line with the directory in which the singlestoredb-studio file resides on the host.

      In this example, the directory is /opt/singlestore/singlestoredb-studio.

      [Unit]
      Description=SingleStoreDB Studio service
      Documentation=https://docs.singlestore.com/studio-redir/systemd
      

      [Service]
      Restart=on-failure
      User=memsql
      ExecStart=/opt/singlestore/singlestoredb-studio/singlestoredb-studio
      

      [Install]
      WantedBy=multi-user.target

  3. Ensure that this file is owned by root.

    sudo chown root:root /etc/systemd/system/singlestoredb-studio.service

  4. Set the requisite file permissions.

    sudo chmod 644 /etc/systemd/system/singlestoredb-studio.service

  5. Start the singlestoredb-studio service.

    sudo systemctl start singlestoredb-studio

  6. Recommended: Enable the singlestoredb-studio service to start Studio after the host is rebooted.

    sudo systemctl enable singlestoredb-studio.service
    Created symlink from /etc/systemd/system/multi-user.target.wants/singlestoredb-studio.service to /etc/systemd/system/singlestoredb-studio.service.

If your Linux distribution does not use systemd, you can run Studio directly. Use nohup to prevent singlestoredb-studio from terminating when you close your terminal session.

  1. Change to the singlestoredb-studio-<version> directory where you unpacked Studio.

    cd singlestoredb-studio-<version>

  2. Start Studio.

    nohup ./singlestoredb-studio > studio.stdout 2> studio.stderr < /dev/null &

Add a New Cluster to Studio

  1. With Studio running, go to http://localhost:8080 on your local host and click Add New Cluster to setup a cluster.

    Important

    Studio is only supported on Chrome and Firefox browsers at this time.

    To run Studio on a different port, add port = <port_name> to /etc/singlestore/singlestoredb-studio.hcl and restart Studio.

  2. Paste the Master Aggregator host IP address into Hostname.

  3. Set Port to the master aggregator database port for your cluster. The default is 3306.

  4. Specify a valid database user in Username.

  5. Enter the Password for your database user.

  6. Click Create Cluster Profile and set Type to describe your cluster: Development, Staging, or Production.

  7. Fill in Cluster Name and Description to your preference.

After you have successfully logged in, you will see the dashboard for your cluster. To run a query against your cluster, navigate to the SQL Editor through the navigation in the left pane.

Last modified: June 25, 2024

Was this article helpful?

On this page

Was this article helpful?