Skip to content
Snippets Groups Projects
Client-Installation-Ubuntu.md 1.39 KiB
Newer Older
# Step-by-Step Installation (Ubuntu)

## Install Ubuntu

You can download it from [ubuntu.com](https://ubuntu.com/download/desktop).

## Install Dependencies

Open a terminal in the folder you want to install Syng in: right click in Nautilus (the file manager) and select *Open in Terminal*.

__Python 3__ should already be installed on your system.
You also need __Git__, [pipx](https://github.com/pypa/pipx) (for installing Poetry), [mpv](https://mpv.io/) (for playing audio and videos) and [yt-dlp](https://github.com/yt-dlp/yt-dlp) (for downloading videos from YouTube).

Install dependencies:
```
sudo add-apt-repository universe
sudo apt update
sudo apt install git pipx mpv yt-dlp
```

[Poetry](https://python-poetry.org/) is recommended for managing the installation.
Install Poetry:
```
pipx install poetry
pipx ensurepath
```

Then close an reopen the terminal.

## Clone Repository

Clone the repository:
```
git clone https://git.k-fortytwo.de/christofsteel/syng2.git
```

Then enter the newly downloaded directory:
```
cd syng2
```

## Install Syng

Now the Python dependencies need to be installed. Poetry is recommended for this step, to not interfere with other Python projects on the same machine.

Install Syng:
```
poetry install -E client
```

## Configure Syng

Syng comes with a graphical configuration utility.

```
poetry run syng-gui
```

## Start Syng

Start Syng:
```
poetry run syng-client
```