search
Link to new docs

Headless Mode (Docker)

Running ontime server without the app

The general case would be to install the application in a local computer that then provides the servers necessary.

However, there is an excellent use case to use ontime in a headless or unnatended server (headless as in, a server without a screen). This could be in a local machine part of the venue's installation, a small Raspberry Pi or even a server running in the cloud.

hashtag
Getting started

Ontime docker image is hosted in docker hub at https://hub.docker.com/r/getontime/ontimearrow-up-right

Using ontimes docker image is similar to any other application and does not warrant specific documentation. However, you can use the below docker-compose to get started

version: "3"

services:
  ontime:
    container_name: ontime
    image: getontime/ontime:latest
    ports:
      - "4001:4001/tcp"
      - "127.0.0.1:8888:8888/udp"
    volumes:
      - "./ontime-db:/server/preloaded-db"
    environment:
      - TZ=Asia/Singapore
    restart: unless-stopped

hashtag
Notes on docker-compose

Ontime uses HTTP / Websockets and OSC to integrate with other apps 4001:4001/tcp binds local port 4001 to container port 4001, this is used for all HTTP and Websockets, you could use port 80 here to reach ontime as http://host instead of http://host:4001

Ports 8888 is used for OSC input into the app, in this config I bind it to the localhost so that it can receive data from the host machine targeted to the loopback interface.

The variations in the network setup will widely depend on your setup

Docker containers default to UTC time, you can use the TZ environment variable to set your own timezone (see below).

circle-info

Use the following as a list of timezones to use in Docker. This is not specific to ontime but to Docker/Linux

The tricky part would be to keep the Editor view open to local network but still offer protection to malicious users.

This feature is in the worklist for after version 1.0.0 release, however it is not being prioritiesed

circle-info

Lets pump this up the priority list: send us an email!

PreviousEdit AnywhereNextNote: Lower thirds in OBS

Last updated