Skip to content

Installation

Jump to bottom
Woolverine94 edited this page Sep 1, 2024 · 25 revisions

biniou uses a Python virtual environment, therefore it is cross-platform and you can run it on the following platforms :

• GNU/Linux
     • OpenSUSE Leap 15.5 / OpenSUSE Tumbleweed
     • Rocky 9.3 / Alma 9.3 / CentOS Stream 9 / Fedora 39
     • Debian 12 / Ubuntu 22.04.3 / Ubuntu 24.04 / Linux Mint 21.2
• Windows 10 / Windows 11
• macOS Intel Homebrew install
• Docker via Dockerfile

biniou itself works inside his Python virtual environment and thus, should be harmless to your system, but its prerequisites could conflict with already installed softwares. If you're not sure how to install, and have this option, use the Dockerfile install method, which does not modify at all your operating system and create an isolated docker container. You could also use a virtual machine with a supported OS.

GNU/Linux

OpenSUSE Leap 15.5 / OpenSUSE Tumbleweed

One-click installer :

  1. Copy/paste and execute the following command in a terminal :
sh <(curl https://raw.githubusercontent.com/Woolverine94/biniou/main/oci-opensuse.sh || wget -O - https://raw.githubusercontent.com/Woolverine94/biniou/main/oci-opensuse.sh)

Rocky 9.3 / Alma 9.3 / CentOS Stream 9 / Fedora 39

One-click installer :

  1. Copy/paste and execute the following command in a terminal :
sh <(curl https://raw.githubusercontent.com/Woolverine94/biniou/main/oci-rhel.sh || wget -O - https://raw.githubusercontent.com/Woolverine94/biniou/main/oci-rhel.sh)

Debian 12 / Ubuntu 22.04.3 / Ubuntu 24.04 / Linux Mint 21.2

One-click installer :

  1. Copy/paste and execute the following command in a terminal :
sh <(curl https://raw.githubusercontent.com/Woolverine94/biniou/main/oci-debian.sh || wget -O - https://raw.githubusercontent.com/Woolverine94/biniou/main/oci-debian.sh)

Manual installation :

  1. Install the pre-requisites as root :
apt install git pip python3 python3-venv gcc perl make ffmpeg openssl
  1. Clone this repository as user :
git clone https://github.com/Woolverine94/biniou.git
  1. Launch the installer :
cd ./biniou
./install.sh
  1. (optional) Install TCMalloc as root to optimize memory management :
apt install google-perftools

Windows 10 / Windows 11

Windows installation has more prerequisites than GNU/Linux one, and requires following softwares (which will be installed automatically) :

  • Git
  • Python
  • OpenSSL
  • Visual Studio Build tools
  • Windows 10/11 SDK
  • Vcredist
  • ffmpeg
  • ... and all their dependencies.

It's a lot of changes on your operating system, and this could potentially bring unwanted behaviors on your system, depending on which softwares are already installed on it.

⚠️ You should really make a backup of your system and datas before starting the installation process. ⚠️

All the installation is automated, but Windows UAC will ask you confirmation for each software installed during the "prerequisites" phase. You can avoid this by running the choosen installer as administrator.

macOS Intel Homebrew install

⚠️ Homebrew install is theoretically compatible with macOS Intel, but has not been tested. Use at your own risk. Also note that biniou is currently incompatible with Apple silicon. ⚠️

⚠️ Update 01/09/2024: Thanks to @lepicodon, there's a workaround for Apple Silicon's users : you can install biniou in a virtual machine using OrbStack. See this comment for explainations. ⚠️

  1. Install Homebrew for your operating system
  2. Install required homebrew "bottles" :
brew install git python3 gcc gcc@11 perl make ffmpeg openssl
  1. Install python virtualenv :
python3 -m pip install virtualenv
  1. Clone this repository as user :
git clone https://github.com/Woolverine94/biniou.git
  1. Launch the installer :
cd ./biniou
./install.sh

Dockerfile

These instructions assumes that you already have a configured and working docker environment.

  1. Create the docker image :
docker build -t biniou https://github.com/Woolverine94/biniou.git

or, for CUDA support :

docker build -t biniou https://raw.githubusercontent.com/Woolverine94/biniou/main/CUDA/Dockerfile
  1. Launch the container :
docker run -it --restart=always -p 7860:7860 \
-v biniou_outputs:/home/biniou/biniou/outputs \
-v biniou_models:/home/biniou/biniou/models \
-v biniou_cache:/home/biniou/.cache/huggingface \
-v biniou_gfpgan:/home/biniou/biniou/gfpgan \
biniou:latest

or, for CUDA support :

docker run -it --gpus all --restart=always -p 7860:7860 \
-v biniou_outputs:/home/biniou/biniou/outputs \
-v biniou_models:/home/biniou/biniou/models \
-v biniou_cache:/home/biniou/.cache/huggingface \
-v biniou_gfpgan:/home/biniou/biniou/gfpgan \
biniou:latest

Note : to save storage space, the previous container launch command defines common shared volumes for all biniou containers and ensure that the container auto-restart in case of OOM crash. Remove --restart and -v arguments if you didn't want these behaviors.

Clone this wiki locally