Skip to content
Whishper

Installing Whishper

Docker Pulls

Installing Whishper is easy. You can install it on your own machine, in a few simple steps.

Requirements

Hardware requirements Whishper is a web application that runs inside a Docker container. This means that you can install it on any machine that supports Docker.

As per system resources, Whishper is a lightweight application, and it doesn’t require a lot of resources to run. However, the more resources you give it, the better it will perform. In small machines, you will experience large transcription times.

Docker Whishper is a collection of servicess, so the easiest way to run it is by using Docker. You can find instructions on how to install Docker on your machine on the official Docker documentation.

You can also run the official docker script to install Docker on your machine:

curl -fsSL https://get.docker.com | sudo sh

Quick Install

The whishper repo contains a useful bash script that will install Whishper for you.

Linux / macOS

You can run it with the following command:

# Get the script
curl -fsSL -o get-whishper.sh https://raw.githubusercontent.com/pluja/whishper/main/get-whishper.sh
# Run it
bash get-whishper.sh

Just follow the steps, to get it setup with Docker. After the script finishes, you will be able to access Whishper at http://localhost:8082.

Windows

Download the installation bat script from the repo:

# Get the script
curl -fsSL -o get-whishper.ps1 https://raw.githubusercontent.com/pluja/whishper/main/get-whishper.bat

Once you have the script, make sure you have Docker installed and running, and then run the script.

Just follow the steps, to get it setup with Docker. After the script finishes, you will be able to access Whishper at http://localhost:8082.

Manual Install

To install Whishper, you need to follow these steps:

1. Get the necessary files from the repository:
 curl -o docker-compose.yml https://raw.githubusercontent.com/pluja/whishper/main/docker-compose.yml && \
 curl -o .env https://raw.githubusercontent.com/pluja/whishper/main/example.env && \
 curl -o nginx.conf https://raw.githubusercontent.com/pluja/whishper/main/nginx.conf
2. Edit the .env file to your liking. Check out the configuration page for more information.
3. Create directories needed for libretranslate and give these the right permissions:

This step is needed because libretranslate runs as a non-root user inside the container, and it needs to write to this folder so it can store the translation models.

mkdir -p ./whishper_data/libretranslate/{data,cache} && \
chown -R 1032:1032 whishper_data/libretranslate
4. Pull the images and start the containers:
docker compose up -d
Done! You can now access Whishper at http://localhost:8082.

If you find any issues during the installation, please open an issue on the repo.

Usage guide Learn how to use Whishper and uleash its full potential!