> For the complete documentation index, see [llms.txt](https://feniks.gitbook.io/doc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://feniks.gitbook.io/doc/feniks/installation.md).

# Installation

The installation process can be done effortlessly since all services are dockerized and can be run by Docker-Compose in one single command. I' ve created a [wizard](https://mehmetgoren.github.io/) to make generating Docker-Compose file easy.

* Install Docker on your system: <https://docs.docker.com/get-docker/>
* Install Docker Compose: <https://docs.docker.com/compose/install/>
* Create docker-compose.yml file by using the [wizard](https://mehmetgoren.github.io/)

<div align="center"><figure><img src="/files/DLFVUP2rdLTVy1qoy8q2" alt=""><figcaption></figcaption></figure></div>

* Open a terminal from the location where the generated docker-compose.yml file is located.
* Run 'docker-compose up' command to start Feniks.
* Open your browser and navigate to '[http://localhost:8080](http://localhost:8080/)' after all service is initialized.

Runs natively on Linux. Windows and macOS are currently not supported. It was tested on X86 CPUs, Nvidia GPUs(both hardware encoding and decoding), Raspberry PI 4 and Nvidia Jetson Nano.