Skip to main content
Version: V2.0.5.1

2.1.Installation and Run


System Environment Requirements

ItemRequirementDescription
Key AuthenticationSSH Public KeyPasswordless SSH connection
Disk Space>=13GBFor storing models and dependencies

File Structure Preparation

warning

Each release package has a different filename and a timestamp, so you need to modify the filename and directory name accordingly each time you execute the following command.

Transfer tkvoice_release_0.3.25_0324_101621.tar from your local computer to the Orin board at 41.2:

scp tkvoice_release_0.3.25_0324_101621.tar nvidia@192.168.41.2:/home/nvidia

Then the following file appears on Orin version 41.2:

nvidia/
└── tkvoice_release_0.3.25_0324_101621.tar

After logging in to the Orin board at 41.2, first extract only the install.sh script from tkvoice_release_0.3.25_0324_101621.tar. Other extraction will be done by the installation script as needed:

tar -xvf tkvoice_release_0.3.25_0324_101621.tar tkvoice_release_0.3.25_0324_101621/install.sh

The following directory structure is obtained:

nvidia/
├── tkvoice_release_0.3.25_0324_101621.tar
└── tkvoice_release_0.3.25_0324_101621/
└── install.sh

Installation

Enter the directory and run the installation script:

cd tkvoice_release_0.3.25_0324_101621
./install.sh
warning

When executing install.sh, you will be prompted to enter passwords multiple times. Please pay attention to whether you need to enter the password for the ubuntu user on x86 or the nvidia user on the Orin board

This installation script will perform the following operations:

  1. Transfer files needed by docker_funasr to x86, install Docker on x86 board, import image, and start container running Funasr service
  2. Install Ollama service on Orin board, import qwen2.5_1.5b.tar.gz large language model
  3. Install necessary Python packages, including piper-tts, onnxruntime-gpu, websockets

If the install.sh script executes successfully, the installation of the tkvoice project is complete.

Testing and Running

First, log in to the Orin board at 41.2 and enter the directory:

cd tkvoice_release_0.3.25_0324_101621

Then you can use the following commands for management:

# Start service
./tkvoice.sh start

# Stop service
./tkvoice.sh stop

# Restart service
./tkvoice.sh restart

# Check status
./tkvoice.sh status

# View logs
tail -f /home/nvidia/tkvoice_release_0.3.25_0324_101621/tkvoice.log
warning

If you have successfully completed this step, it means that the overall process is complete. You can then selectively browse the subsequent tkvoice documentation, only looking at the parts you need.

Uninstall

Since this project consumes a lot of disk space, you can uninstall it when you urgently need disk space and reinstall it later when needed.

When executing uninstall.sh, you will be prompted to enter your password multiple times. Please make sure you are entering the password for the Ubuntu user on the x86 board or the password for the NVIDIA user on the Orin board.

danger
  • The uninstallation script will uninstall the ollama container and image on the Orin board and the Funasr container and image on x86, as well as the Docker service. Please use it with caution.
  • After executing uninstall.sh, the ~/tkvoice_release_0.3.25_0324_101621 directory will be deleted, meaning the uninstallation script itself will also be deleted. However, the ~/tkvoice_release_0.3.25_0324_101621.tar file will not be deleted.
cd ~/tkvoice_release_0.3.25_0324_101621
chmod +x uninstall.sh
./uninstall.sh