Skip to content
OneLiveRec

Installation

OneLiveRec is available in three variants: Desktop, Container Image, and CLI. The main functionality of the Desktop is identical to the CLI, except for some UI and System features. The functionality of the Container Image is completely identical to the CLI. You can choose the right variant for your needs.

OneLiveRec Desktop

Section titled “OneLiveRec Desktop”

If you have no idea which variant is suited for you or you are not familiar with CLI, we recommend using the Desktop variant for easy setup and use.

  1. Download the OneLiveRec installer by clicking the button below

    Download

  2. Run the installer, then follow the wizard to finish the installation.

    installer

OneLiveRec Container Image

Section titled “OneLiveRec Container Image”

You can run the container image by Docker Compose or Docker CLI as follows

  1. Create an app directory and change into the directory

    mkdir -p ~/orec && cd ~/orec

  2. Create a file named compose.yaml and paste the following code in

    name: oneliverec
    

    services:
      orec:
        image: oneliverec/orec:latest
        command: -u ${OREC_USERNAME?error} -p ${OREC_PASSWORD?error}
        restart: unless-stopped
        ports:
          - '127.0.0.1:5202:5202'
        volumes:
          - ${PWD}:/app
          - /etc/machine-id:/etc/machine-id:ro
        environment:
          - TZ=${TZ:-UTC}
          - PUID=${PUID:-0}
          - PGID=${PGID:-0}
          - UMASK=${UMASK:-002}
        healthcheck:
          test: curl -f http://${OREC_USERNAME}:${OREC_PASSWORD}@localhost:5202/health || exit 1
          retries: 3
          timeout: 10s
          interval: 1m
          start_period: 1s
          start_interval: 3s
    

      caddy:
        image: caddy:latest
        restart: unless-stopped
        ports:
          - '80:80'
          - '443:443'
        volumes:
          - ./Caddyfile:/etc/caddy/Caddyfile
          - caddy_data:/data
          - caddy_config:/config
        environment:
          OREC_HOSTS: '${OREC_HOSTS?error}'
        depends_on:
          orec:
            restart: true
            condition: service_healthy
    

    volumes:
      caddy_data:
      caddy_config:

  3. Create a file called Caddyfile and paste in the following

    (redirect) {
      @http {
        protocol http
      }
      redir @http https://{host}{uri}
    }
    

    {$OREC_HOSTS} {
      reverse_proxy orec:5202
    }

  4. Create a .env config file by running the following command

    Replace example.com with your host (hosts are separated by a comma)

    cat <<EOF > .env
    PUID=$(id -u)
    PGID=$(id -g)
    UMASK=$(umask)
    TZ=$(cat /etc/timezone)
    OREC_HOSTS=orec.localhost, example.com
    OREC_USERNAME=username
    OREC_PASSWORD=password
    EOF

  5. Start up OneLiveRec by running the following command

    docker compose up -d

  6. Open web UI

    If you are running OneLiveRec using the default address binding on a machine with a GUI, you can click the link below to open the web UI in the default browser on your local machine.

    https://orec.localhost

OneLiveRec CLI

Section titled “OneLiveRec CLI”

The CLI variant is portable, so you just need to download the archive and extract the files somewhere, then run the executable.

  1. Download archive

    Invoke-WebRequest -Uri https://github.com/oneliverec/OneLiveRec/releases/download/v0.2.2/orec-0.2.2-x86_64-pc-windows-msvc.zip -OutFile orec-0.2.2-x86_64-pc-windows-msvc.zip

  2. Extract files

    Expand-Archive -LiteralPath orec-0.2.2-x86_64-pc-windows-msvc.zip -DestinationPath orec-0.2.2-x86_64-pc-windows-msvc
    Set-Location orec-0.2.2-x86_64-pc-windows-msvc

  3. Run OneLiveRec

    .\orec.exe run -u username -p password

  4. Open web UI

    If you are running OneLiveRec using the default address binding on a machine with a GUI, you can click the link below to open the web UI in the default browser on your local machine.

    http://localhost:5202

See also

Section titled “See also”