Installing Texera on a Single Node - apache/texera GitHub Wiki

This document describes how to set up and run Texera on a single machine using "Docker Compose".

Prerequisites

Before starting, make sure your computer meets the following requirements:

Resource Type Minimum Recommended
CPU Cores 2 8
Memory 4GB 16GB
Disk Space 20GB 50GB

You also need to install and launch Docker Desktop on your computer. Choose the right installation link for your computer:

Operating System Installation Link
macOS Docker Desktop for Mac
Windows Docker Desktop for Windows
Linux Docker Desktop for Linux

After installing and launching Docker Desktop, verify that Docker and Docker Compose are available by running the following commands from the command line:

docker --version
docker compose version

You should see output messages like the following (your versions may be different):

$ docker --version
Docker version 27.5.1, build 9f9e405
$ docker compose version
Docker Compose version v2.23.0-desktop.1

Download Texera Installer (a few kilobytes)

Download texera-single-node-release and extract it.

Launch Texera

Go to the extracted directory using the following command:

cd apache-texera-incubating-release-1-1-0-single-node

Run the following command to start Texera:

docker compose up

If you see the error message like unable to get image 'nginx:alpine': Cannot connect to the Docker daemon at unix:///Users/kunwoopark/.docker/run/docker.sock. Is the docker daemon running?, please make sure Docker Desktop is installed and running

When you start Texera for the first time, it will take around 5 minutes to download needed images. If you enable the R support, it will take around 20 minutes

The system is ready when you see the following messages:

......
texera-access-message              | ===============================================
texera-access-message              | Texera is ready!
texera-access-message              | ===============================================
texera-access-message              | 
texera-access-message              | To access Texera, open your browser and navigate to:
texera-access-message              |     http://localhost:8080
texera-access-message              | 
texera-access-message              | The following account has been created for you:
texera-access-message              |     Username: texera
texera-access-message              |     Password: texera
texera-access-message              | 
texera-access-message              | ===============================================
......
some health check messages
......

Open your browser and navigate to:

http://localhost:8080

An account texera with password texera is already setup and pre-filled for you. You can click on the Sign In button to login:

You should see the following page:

Note: Texera does NOT support R operators by default. To enable R support, refer to the Advanced Settings section.

Stop, Restart, and Uninstall Texera

Stop

Press Ctrl+C in the terminal to stop Texera.

If you already closed the terminal, you can go to the installation folder and run:

docker compose stop

to stop Texera.

Restart

Same as the way you launch Texera.

Uninstall

To remove Texera and all its data, go to the installation folder and run:

docker compose down -v

⚠️ Warning: This will permanently delete all the data used by Texera.

Advanced Settings

Before making any of the changes below, please stop Texera first. Once you finish the changes, restart Texera to apply them.

All changes are to the docker-compose.yml file in the installation folder.

Enable Support of the R Programming Language

To support R user-defined-function (UDF) operators, find the computing-unit-master section and change the image tag from release-1-1-0 to release-1-1-0-R.

Run Texera on other ports

By default, Texera uses:

  • Port 8080 for its web service
  • Port 9000 for its MinIO storage service

To change these ports:

  • For the web service port (8080):
    • Find the nginx service section and change the port mapping from "8080:8080" to your desired port mapping, e.g., "8081:8080".
    • Find the texera-access-message service section and change the port in ${TEXERA_HOST}:8080 to your desired port, e.g. ${TEXERA_HOST}:8081
  • For the MinIO port (9000):
    • Find the minio service section and change the port mapping from "9000:9000" to your desired port mapping, e.g., "9001:9000".
    • Find the lakefs service section and update the port number of the LAKEFS_BLOCKSTORE_S3_PRE_SIGNED_ENDPOINT from 9000 to your desired port, e.g., 9001.

Change the locations of Texera data

By default, Docker manages Texera's data locations. To change them to your own locations:

  • Find the persistent volumes section. For each data volume you want to specify, add the following configuration:

    volume_name:
  driver: local
  driver_opts:
    type: none
    o: bind
    device: /path/to/your/local/folder

    For example, to change the folder of storing workflow_result_data to /Users/johndoe/texera/data, add the following:

    workflow_result_data:
  driver: local
  driver_opts:
    type: none
    o: bind
    device: /Users/johndoe/texera/data

If you already launched texera and want to change the data locations, existing data volumes need to be recreated and override in the next boot-up, i.e. select y when running docker compose up again:

$ docker compose up
? Volume "texera-single-node-release-1-1-0_workflow_result_data" exists but doesn't match configuration in compose file. Recreate (data will be lost)? (y/N)
y // answer y to this prompt