holtwick/briefing-pro repository overview

⁠Briefing Pro

Learn more about the project in general at about.brie.fi⁠.

To run Briefing out of the box try this and open at http://localhost:8080⁠:

docker run -p 8080:8080 holtwick/briefing-pro

For more advanced configuration we recommend using Docker Compose. This is a simple script to start with:

services:
  app:
    image: holtwick/briefing-pro
    restart: unless-stopped
    env_file:
      - .env
    volumes:
      - ./data:/app/data # config
      - ./logs:/app/logs # logs
    ports:
      - 3478:3478 # stun
      - 8080:8080 # http

In the .env file you should at least put a unique AUTH token, whchich simplifies further configuration. Create on by hand, using you preferred password manager or this command openssl rand -base64 36:

AUTH=Pa55w0rd!123

When starting up by docker compose up -d it should work now. On problemns look into the logs like docker compose logs -f.

⁠Configuration

Briefing offers two ways for configuration:

1. Using environment variables
2. Using the web interface

The later is the recommended way for beginners. Navigate to http://localhost:8080/config/⁠ and enter the AUTH secret, mentioned before.