Skip to content

Server Installtion guide

Docker

The YC docker iamge can be pulled from ghcr.io/cc-youcube/youcube:latest

docker pull ghcr.io/cc-youcube/youcube:latest

You can also build the Image your self buy using YouCube's Dockerfile

Docker Compose

This is an example of using the image with docker-compose

version: "2.0"
services:
  youcube:
    image: ghcr.io/cc-youcube/youcube:latest
    restart: always
    hostname: youcube
    ports:
      - 5000:5000

NVIDIA

Warning

Please make sure to install the NVIDIA driver for your GPU before continuing with this installation guide.

Install the NVIDIA driver container toolkit by following this guide by NVIDIA. Make sure that the YC docker image you're using has NVIDIA in the tag. Please refer to the tag list to discover all the available tags.

NVIDIA Docker Compose

Add this to the above-mentioned docker compose configuration.

runtime: nvidia
environment:
    - NVIDIA_VISIBLE_DEVICES=all
    - NVIDIA_DRIVER_CAPABILITIES=compute

Manual Installation

Danger

Installing YC manually is not recommended due to potential security risks. However, if you still choose to proceed with manual installation, it is important to run the YC server using a user account that has limited permissions. By doing so, you can reduce the potential damage caused by an attacker.

Firstly clone the repository.

git clone https://github.com/CC-YouCube/server.git
git clone git@github.com:CC-YouCube/server.git
gh repo clone CC-YouCube/server

Open with GitHub Desktop

Note

If nothing happens, download GitHub Desktop and try again.

Then you'll need to install the following dependencies to install the YouCube server:


Last update: November 15, 2023