spaleks/pdfinsieme repository overview

⁠PDFInsieme

⁠

PDFInsieme is a collaborative presentation tool.
It was originally designed to solve a common problem in video calls:
when sharing a PDF presentation, only one person controls the slides, and everyone else has to say “please click next”.

With PDFInsieme, participants can stay in sync automatically.
The presenter advances the slides, and all viewers (including guests) see the same page in real time.
Additional features include a presenter view, shared laser pointer, upload handling, and guest access links.

⁠Docker Compose

Here is an example docker-compose.yml setup:

services:
  web:
    image: spaleks/pdfinsieme:latest
    # or if you prefer quay.io
    # image: quay.io/spaleks/pdfinsieme:latest
    container_name: pdfinsieme
    volumes:
      - ./.env:/app/.env:ro
      - ./volumes/data:/app/data

• Create a .env file based on .env.example.
• ./volumes/data persists uploaded PDFs and room data.

⁠Configuration

Configuration is handled via environment variables.
Only the following variables need to be set:

• SECRET_KEY
  A secret key for Flask session security.
  Example: changeme-in-production

• MAX_CONTENT_MB
  Maximum allowed upload size for PDF files (in megabytes).
  Example: 64 (for 64 MB)

• APP_HOST (optional, for cli use)
  Interface to bind the HTTP server to.
  Defaults to 0.0.0.0.

• PORT (optional, for cli use)
  Port exposed by the HTTP/WebSocket server.
  Defaults to 14341.

• PDFINSIEME_DATA_ROOT (optional, for cli use)
  Directory containing uploaded PDFs and other runtime data.
  Defaults to ./data.

• PDFINSIEME_DB_PATH (optional, for cli use)
  Path to the SQLite database file.
  Defaults to <PDFINSIEME_DATA_ROOT>/database.db.

• SOCKETIO_ASYNC_MODE (optional)
  Controls which async server Flask-SocketIO uses.
  Defaults to eventlet, which provides a production-ready WSGI/WebSocket server.
  Set to threading only for debugging, noting that this falls back to the Werkzeug dev server.

• SOCKETIO_LOG_OUTPUT (optional)
  Enables per-request logging when running on Eventlet.
  Defaults to true. Set to false to silence HTTP access logs.

See .env.example for a template.

⁠License

MIT