gluk46546546/openmark repository overview

graph LR
    subgraph "Your Application"
        CLIENT[👤 Client Browser]
        SERVER[🖥️ Your Server]
    end

    subgraph "OpenMark"
        OM[📄 OpenMark<br/>Docker Container]
    end

    subgraph "Storage"
        PDF[(📁 PDF Repository)]
        DB[(💾 Database)]
    end

    SERVER -->|1. POST /api/quickView| OM
    OM -->|2. Return DAT + viewUrl| SERVER
    SERVER -->|3. Send viewer URL| CLIENT
    CLIENT -->|4. Load viewer| OM
    OM -->|5. Fetch PDF| PDF
    OM -->|6. Load/Save annotations| DB

    style CLIENT fill:#e1f5fe
    style SERVER fill:#fff3e0
    style OM fill:#e8f5e9
    style PDF fill:#fce4ec
    style DB fill:#f3e5f5

# Pull the official image
docker pull gluk46546546/openmark:latest

# Run with default configuration
docker run -d -p 5000:5000 gluk46546546/openmark:latest

# Or with custom configuration
docker run -d -p 5000:5000 \
  -v ./config.json:/app/config.json:ro \
  gluk46546546/openmark:latest

version: "3.8"
services:
  openmark:
    image: gluk46546546/openmark:latest
    ports:
      - "5000:5000"
    volumes:
      - ./config.json:/app/config.json:ro
      - ./data:/app/data

cd dev
docker-compose up -d

{
  "server": {
    "host": "0.0.0.0",
    "port": 5000,
    "secret_key": "your-secret-key-min-32-characters"
  },
  "plugins": {
    "authentication": {
      "type": "local",
      "config": { "users_file": "./data/users.json" }
    },
    "pdf_source": {
      "type": "http",
      "config": { "base_url": "https://your-pdf-server.com/" }
    },
    "annotations": {
      "type": "local",
      "config": { "storage_path": "./data/annotations.json" }
    }
  }
}

import requests

OPENMARK_URL = "https://your-openmark-server.com"

# One-step authentication and document request
response = requests.post(f"{OPENMARK_URL}/api/quickView", json={
    "username": "user",
    "password": "password",
    "documentId": "invoice_001"
})

data = response.json()
viewer_url = OPENMARK_URL + data["viewUrl"]

# Send this URL to your client application
# The viewer URL contains a JWT token valid for 2 hours
print(f"Open in browser or iframe: {viewer_url}")