openfoia/config.example.json at main · JordanCoin/openfoia · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
{
  "$schema": "https://openfoia.dev/config-schema.json",
  "_comment": "Copy this to ~/.openfoia/config.json and fill in your keys",

  "ai": {
    "_comment": "Choose ONE provider. Local models recommended for privacy.",

    "provider": "ollama",
    "ollama": {
      "base_url": "http://localhost:11434",
      "model": "llama3.2"
    },

    "_alt_anthropic": {
      "provider": "anthropic",
      "api_key": "sk-ant-...",
      "model": "claude-sonnet-4-20250514"
    },

    "_alt_openai": {
      "provider": "openai",
      "api_key": "sk-...",
      "model": "gpt-4o"
    },

    "_alt_local_llamacpp": {
      "provider": "openai",
      "base_url": "http://localhost:8080/v1",
      "api_key": "not-needed",
      "model": "local"
    }
  },

  "pdf_extract": {
    "_comment": "Direct PDF text extraction. Fast, lossless, no OCR needed for born-digital PDFs. Set binary_path to empty string to disable.",
    "binary_path": null,
    "min_chars_threshold": 50
  },

  "ocr": {
    "_comment": "OCR fallback for scanned documents. Only runs when PDF text extraction returns nothing.",

    "backend": "tesseract",

    "_alt_google": {
      "backend": "google",
      "credentials_file": "~/.openfoia/google-credentials.json"
    },

    "_alt_aws": {
      "backend": "aws",
      "region": "us-east-1",
      "access_key_id": "AKIA...",
      "secret_access_key": "..."
    }
  },

  "gateways": {
    "_comment": "Optional. Only needed if you want to SEND requests (vs just tracking).",

    "email": {
      "smtp_host": "smtp.gmail.com",
      "smtp_port": 587,
      "smtp_user": "you@gmail.com",
      "_smtp_password": "app-specific-password",
      "from_name": "Your Name"
    },

    "fax": {
      "_comment": "Twilio Programmable Fax - $0.07/page",
      "provider": "twilio",
      "_account_sid": "AC...",
      "_auth_token": "...",
      "from_number": "+1234567890"
    },

    "mail": {
      "_comment": "Lob.com - Physical mail API - ~$1/letter",
      "provider": "lob",
      "_api_key": "live_...",
      "return_address": {
        "name": "Your Name",
        "address_line1": "123 Main St",
        "address_city": "Anytown",
        "address_state": "NY",
        "address_zip": "10001"
      }
    }
  },

  "entities": {
    "_comment": "Custom entity types for your investigation domain",

    "custom_types": [
      {
        "name": "CONTRACT_NUMBER",
        "pattern": "\\b[A-Z]{2,4}-\\d{4,}-\\d{4,}\\b",
        "description": "Federal contract numbers"
      },
      {
        "name": "CASE_NUMBER",
        "pattern": "\\b\\d{2}-cv-\\d{4,}\\b",
        "description": "Federal court case numbers"
      },
      {
        "name": "FOIA_TRACKING",
        "pattern": "\\bFOI[A]?-\\d{4}-\\d+\\b",
        "description": "Agency FOIA tracking numbers"
      }
    ],

    "extraction_prompt_suffix": "Also look for federal contract numbers, court case numbers, and agency-specific identifiers."
  },

  "privacy": {
    "browser_default": "brave",
    "always_private_mode": true,
    "auto_redact_pii_in_exports": true,
    "delete_processed_originals": false
  },

  "server": {
    "host": "127.0.0.1",
    "port": 0,
    "_comment_port": "0 = random available port"
  }
}