AGPL-3.0-or-later, with a README note offering other terms on request for newsrooms and public-interest projects. README rewritten in English, replacing a 55 KB Swedish document that described a Sweden-only tool. It states plainly what is and is not yet country-agnostic rather than overselling: the schema still carries Swedish column names, and docs/SCHEMA.md translates them until the rename lands. docs/PORTING.md is the guide this whole effort exists for — what a Bulgarian, UK or EU deployment actually has to write. It is honest about the parts that are real work (the ingest adapter, data quality, the untranslated UI) and about the assumption underneath the data model, so nobody invests in an adapter for a parliament that does not fit. SECURITY.md documents the database_query issue rather than leaving deployers to find it, and gives the read-only role to run against. .env.example documents all 48 environment variables, which were previously discoverable only by grep. CI runs ruff, applies schema.sql to a clean pgvector database, runs the tests, builds the frontend, and scans for secrets. The schema step exists because that file drifted from production once already. tsc is non-blocking until the nine inherited type errors are fixed. Makefile rewritten around a documented setup/dev/test/lint flow, and carries the check-fork-divergence target the production fork uses to prove it differs from upstream only under deploy/prod/. Also removed the personal GitHub Copilot instructions file. Verified: no secrets, no personal contact details, and no private IPs or hostnames in shipped source; backend still imports. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>main
parent
b8a775ca27
commit
68efc0dcf9
9 changed files with 1324 additions and 21 deletions
@ -0,0 +1,88 @@ |
|||||||
|
# Copy to .env and fill in. .env is gitignored and must never be committed. |
||||||
|
# |
||||||
|
# Note: values are read with python-dotenv, which tolerates characters that a |
||||||
|
# plain `source .env` in bash would choke on (parentheses, spaces). Don't assume |
||||||
|
# shell scripts can source this file. |
||||||
|
|
||||||
|
# ── Database ────────────────────────────────────────────────────────────────── |
||||||
|
PG_HOST=localhost |
||||||
|
PG_PORT=5432 |
||||||
|
PG_DB=plenum |
||||||
|
PG_USER=plenum |
||||||
|
PG_PASSWORD= |
||||||
|
|
||||||
|
# Guardrails applied to every pooled connection. The defaults suit an interactive |
||||||
|
# API; batch jobs may want a larger work_mem and no statement timeout. |
||||||
|
PG_POOL_MINCONN=1 |
||||||
|
PG_POOL_MAXCONN=6 |
||||||
|
PG_APPLICATION_NAME=plenum |
||||||
|
PG_WORK_MEM=32MB |
||||||
|
PG_TEMP_FILE_LIMIT=1GB |
||||||
|
PG_STATEMENT_TIMEOUT_MS=30000 |
||||||
|
PG_LOCK_TIMEOUT_MS=5000 |
||||||
|
PG_IDLE_IN_TRANSACTION_SESSION_TIMEOUT_MS=10000 |
||||||
|
|
||||||
|
# ── Chat model ──────────────────────────────────────────────────────────────── |
||||||
|
# Any OpenAI-compatible endpoint, including the /v1 suffix. |
||||||
|
LLM_DIRECT_URL=http://localhost:8000/v1 |
||||||
|
# Bearer token for the endpoint above. Leave empty for an unauthenticated local server. |
||||||
|
LLM_BEARER= |
||||||
|
|
||||||
|
# The orchestrator and the final answer. Worth the strongest model you have. |
||||||
|
LLM_MODEL_SMART= |
||||||
|
# Summarising tool results and other mechanical work. A smaller model is fine. |
||||||
|
LLM_MODEL_FAST= |
||||||
|
# Fallback when neither of the above is set. |
||||||
|
LLM_MODEL= |
||||||
|
|
||||||
|
# ── Embeddings ──────────────────────────────────────────────────────────────── |
||||||
|
# Separate endpoint, because embedding usually runs on a different server than chat. |
||||||
|
EMBEDDING_BASE_URL=http://localhost:8003/v1 |
||||||
|
EMBEDDING_API_KEY= |
||||||
|
# Must produce vectors of the width declared as embeddings.dimension in |
||||||
|
# parliament.yaml. Changing this requires re-embedding the whole corpus. |
||||||
|
LLM_MODEL_EMBEDDING= |
||||||
|
|
||||||
|
# ── Optional: additional providers ──────────────────────────────────────────── |
||||||
|
# Only needed for providers listed in providers.yaml with user_api_key: false. |
||||||
|
# Keys that users supply in the browser are never stored server-side. |
||||||
|
BERGET_API_KEY= |
||||||
|
BERGET_BASE_URL= |
||||||
|
BERGET_MODEL= |
||||||
|
GOOGLE_GEMINI_KEY= |
||||||
|
|
||||||
|
# ── Application ─────────────────────────────────────────────────────────────── |
||||||
|
# HMAC secret for the zero-knowledge login challenge. Generate with: |
||||||
|
# python -c "import secrets; print(secrets.token_hex(32))" |
||||||
|
AUTH_PRELOGIN_SECRET= |
||||||
|
|
||||||
|
# Where downloaded corpora live. Defaults to ./data. Point this at an existing |
||||||
|
# download to reuse it rather than fetching again. |
||||||
|
PLENUM_DATA_DIR= |
||||||
|
|
||||||
|
# Use a parliament.yaml / prompt tree outside the repository, so a deployment's |
||||||
|
# own values never show up in a diff against upstream. |
||||||
|
# PARLIAMENT_CONFIG=/etc/plenum/parliament.yaml |
||||||
|
# PROMPTS_DIR=/etc/plenum/prompts |
||||||
|
|
||||||
|
# Re-read prompt files on every call. Development only. |
||||||
|
# PROMPTS_RELOAD=1 |
||||||
|
|
||||||
|
# ── Deep research tuning ────────────────────────────────────────────────────── |
||||||
|
# All optional; the defaults in backend/services/research/ are sensible. Listed |
||||||
|
# here so they are discoverable rather than only findable by grep. |
||||||
|
# RESEARCH_PROPOSAL_COUNT=6 # threads proposed after the scout pass |
||||||
|
# RESEARCH_FOLLOWUP_COUNT=3 # follow-up threads suggested after a dig |
||||||
|
# RESEARCH_MAX_THREADS=12 # hard cap per board |
||||||
|
# RESEARCH_TARGET_DEPTH=2 # how many dig rounds a thread gets |
||||||
|
# RESEARCH_SCOUT_ROUNDS=2 |
||||||
|
# RESEARCH_SCOUT_MATERIAL_CHARS=40000 |
||||||
|
# RESEARCH_TRIP_MAX_TURNS=14 # tool-call turns per thread before forcing an answer |
||||||
|
# RESEARCH_TOOL_RESULT_CHARS=8000 # per-result truncation fed back to the model |
||||||
|
# RESEARCH_ANSWER_MAX_TOKENS=1500 |
||||||
|
# RESEARCH_REPORT_MAX_TOKENS=4000 |
||||||
|
# RESEARCH_MAX_RUNNING_JOBS=3 # server-wide concurrency |
||||||
|
# RESEARCH_MAX_BYO_JOBS_PER_OWNER=1 # concurrency for users on their own API key |
||||||
|
# RESEARCH_MAX_JOB_RUNTIME_SECS=3600 |
||||||
|
# RESEARCH_HEARTBEAT_SECS=20 |
||||||
|
# RESEARCH_STALE_HEARTBEAT_SECS=180 # after this, a job is considered dead and reaped |
||||||
@ -0,0 +1,85 @@ |
|||||||
|
name: CI |
||||||
|
|
||||||
|
on: |
||||||
|
push: |
||||||
|
branches: [main] |
||||||
|
pull_request: |
||||||
|
|
||||||
|
jobs: |
||||||
|
secrets: |
||||||
|
name: Secret scan |
||||||
|
runs-on: ubuntu-latest |
||||||
|
steps: |
||||||
|
- uses: actions/checkout@v4 |
||||||
|
with: |
||||||
|
fetch-depth: 0 |
||||||
|
# This repository's predecessor committed a VPN backup and a plaintext |
||||||
|
# database password. This job exists so that cannot happen again. |
||||||
|
- uses: gitleaks/gitleaks-action@v2 |
||||||
|
env: |
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
||||||
|
|
||||||
|
python: |
||||||
|
name: Python |
||||||
|
runs-on: ubuntu-latest |
||||||
|
services: |
||||||
|
postgres: |
||||||
|
image: pgvector/pgvector:pg16 |
||||||
|
env: |
||||||
|
POSTGRES_USER: plenum |
||||||
|
POSTGRES_PASSWORD: plenum |
||||||
|
POSTGRES_DB: plenum |
||||||
|
ports: ["5432:5432"] |
||||||
|
options: >- |
||||||
|
--health-cmd pg_isready --health-interval 10s |
||||||
|
--health-timeout 5s --health-retries 5 |
||||||
|
env: |
||||||
|
PG_HOST: localhost |
||||||
|
PG_USER: plenum |
||||||
|
PG_PASSWORD: plenum |
||||||
|
PG_DB: plenum |
||||||
|
LLM_DIRECT_URL: http://localhost:9/v1 # never called; tests must not need a model |
||||||
|
steps: |
||||||
|
- uses: actions/checkout@v4 |
||||||
|
- uses: actions/setup-python@v5 |
||||||
|
with: |
||||||
|
python-version: "3.11" |
||||||
|
cache: pip |
||||||
|
|
||||||
|
- run: pip install -e ".[dev]" |
||||||
|
|
||||||
|
- name: Lint |
||||||
|
run: ruff check . |
||||||
|
|
||||||
|
# Proves the schema file is complete and self-consistent. It drifted badly |
||||||
|
# from production once; this stops that recurring silently. |
||||||
|
- name: Apply schema to a clean database |
||||||
|
run: | |
||||||
|
psql -h localhost -U plenum -d plenum -v ON_ERROR_STOP=1 \ |
||||||
|
-c "ALTER DATABASE plenum SET app.fts_config = 'swedish';" |
||||||
|
psql -h localhost -U plenum -d plenum -v ON_ERROR_STOP=1 -f _postgres/schema.sql |
||||||
|
env: |
||||||
|
PGPASSWORD: plenum |
||||||
|
|
||||||
|
- name: Tests |
||||||
|
run: pytest -q |
||||||
|
|
||||||
|
frontend: |
||||||
|
name: Frontend |
||||||
|
runs-on: ubuntu-latest |
||||||
|
defaults: |
||||||
|
run: |
||||||
|
working-directory: frontend |
||||||
|
steps: |
||||||
|
- uses: actions/checkout@v4 |
||||||
|
- uses: actions/setup-node@v4 |
||||||
|
with: |
||||||
|
node-version: "20" |
||||||
|
cache: npm |
||||||
|
cache-dependency-path: frontend/package-lock.json |
||||||
|
- run: npm ci |
||||||
|
# Not blocking yet: there are pre-existing type errors inherited from the |
||||||
|
# predecessor repository. Remove `continue-on-error` once they are fixed. |
||||||
|
- run: npx tsc --noEmit |
||||||
|
continue-on-error: true |
||||||
|
- run: npm run build |
||||||
@ -0,0 +1,53 @@ |
|||||||
|
# Contributing |
||||||
|
|
||||||
|
## The one rule |
||||||
|
|
||||||
|
Answers must be traceable to sources. This is a tool for journalists and |
||||||
|
researchers, so a claim the user cannot verify is a defect even when it happens to |
||||||
|
be true. Changes to prompts, retrieval or citation handling are judged on whether |
||||||
|
they preserve that. |
||||||
|
|
||||||
|
## Keeping it country-agnostic |
||||||
|
|
||||||
|
Before hardcoding anything Swedish, check whether it belongs in configuration: |
||||||
|
|
||||||
|
- A party, colour, committee, activity code, identifier shape or source URL → |
||||||
|
`parliament.yaml` |
||||||
|
- Text the model reads → `prompts/<lang>/` |
||||||
|
- Text the user reads → `content/<lang>/` or, for now, the component |
||||||
|
- Knowledge of one portal's JSON → `ingest/adapters/` |
||||||
|
|
||||||
|
## Setup |
||||||
|
|
||||||
|
```bash |
||||||
|
python -m venv .venv && .venv/bin/pip install -e ".[dev]" |
||||||
|
cp .env.example .env |
||||||
|
``` |
||||||
|
|
||||||
|
`ruff check .` and `pytest -q` are what CI runs. Neither needs a model endpoint; |
||||||
|
tests that would call one should be skipped rather than mocked into passing. |
||||||
|
|
||||||
|
## Prompts |
||||||
|
|
||||||
|
Edit the files under `prompts/`, not Python. Run with `PROMPTS_RELOAD=1` to skip |
||||||
|
restarting between edits. |
||||||
|
|
||||||
|
`tests/test_prompts_golden.py` asserts prompts match their snapshots. If you change a |
||||||
|
prompt deliberately, regenerate with `python tests/test_prompts_golden.py --update` |
||||||
|
and include the diff in your pull request — a silent prompt change shows up later as |
||||||
|
subtly worse answers, which is hard to trace back. |
||||||
|
|
||||||
|
## Database changes |
||||||
|
|
||||||
|
Add a migration under `_postgres/migrations/` **and** update `_postgres/schema.sql`. |
||||||
|
CI applies `schema.sql` to a clean database; it drifted from production once and the |
||||||
|
result was a schema newcomers could not run the code against. |
||||||
|
|
||||||
|
Guard migrations so they are no-ops on a database that already has the change. The |
||||||
|
same file then works for a fresh install and an existing deployment. |
||||||
|
|
||||||
|
## Commits |
||||||
|
|
||||||
|
Explain why, not what — the diff shows what. If you worked something out the hard |
||||||
|
way (a provider quirk, a Postgres behaviour, a data oddity), write it down; that is |
||||||
|
usually the most valuable part of the change. |
||||||
@ -0,0 +1,662 @@ |
|||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE |
||||||
|
Version 3, 19 November 2007 |
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> |
||||||
|
Everyone is permitted to copy and distribute verbatim copies |
||||||
|
of this license document, but changing it is not allowed. |
||||||
|
|
||||||
|
Preamble |
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for |
||||||
|
software and other kinds of works, specifically designed to ensure |
||||||
|
cooperation with the community in the case of network server software. |
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed |
||||||
|
to take away your freedom to share and change the works. By contrast, |
||||||
|
our General Public Licenses are intended to guarantee your freedom to |
||||||
|
share and change all versions of a program--to make sure it remains free |
||||||
|
software for all its users. |
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not |
||||||
|
price. Our General Public Licenses are designed to make sure that you |
||||||
|
have the freedom to distribute copies of free software (and charge for |
||||||
|
them if you wish), that you receive source code or can get it if you |
||||||
|
want it, that you can change the software or use pieces of it in new |
||||||
|
free programs, and that you know you can do these things. |
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights |
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer |
||||||
|
you this License which gives you legal permission to copy, distribute |
||||||
|
and/or modify the software. |
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that |
||||||
|
improvements made in alternate versions of the program, if they |
||||||
|
receive widespread use, become available for other developers to |
||||||
|
incorporate. Many developers of free software are heartened and |
||||||
|
encouraged by the resulting cooperation. However, in the case of |
||||||
|
software used on network servers, this result may fail to come about. |
||||||
|
The GNU General Public License permits making a modified version and |
||||||
|
letting the public access it on a server without ever releasing its |
||||||
|
source code to the public. |
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to |
||||||
|
ensure that, in such cases, the modified source code becomes available |
||||||
|
to the community. It requires the operator of a network server to |
||||||
|
provide the source code of the modified version running there to the |
||||||
|
users of that server. Therefore, public use of a modified version, on |
||||||
|
a publicly accessible server, gives the public access to the source |
||||||
|
code of the modified version. |
||||||
|
|
||||||
|
An older license, called the Affero General Public License and |
||||||
|
published by Affero, was designed to accomplish similar goals. This is |
||||||
|
a different license, not a version of the Affero GPL, but Affero has |
||||||
|
released a new version of the Affero GPL which permits relicensing under |
||||||
|
this license. |
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and |
||||||
|
modification follow. |
||||||
|
|
||||||
|
TERMS AND CONDITIONS |
||||||
|
|
||||||
|
0. Definitions. |
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License. |
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of |
||||||
|
works, such as semiconductor masks. |
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this |
||||||
|
License. Each licensee is addressed as "you". "Licensees" and |
||||||
|
"recipients" may be individuals or organizations. |
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work |
||||||
|
in a fashion requiring copyright permission, other than the making of an |
||||||
|
exact copy. The resulting work is called a "modified version" of the |
||||||
|
earlier work or a work "based on" the earlier work. |
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based |
||||||
|
on the Program. |
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without |
||||||
|
permission, would make you directly or secondarily liable for |
||||||
|
infringement under applicable copyright law, except executing it on a |
||||||
|
computer or modifying a private copy. Propagation includes copying, |
||||||
|
distribution (with or without modification), making available to the |
||||||
|
public, and in some countries other activities as well. |
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other |
||||||
|
parties to make or receive copies. Mere interaction with a user through |
||||||
|
a computer network, with no transfer of a copy, is not conveying. |
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices" |
||||||
|
to the extent that it includes a convenient and prominently visible |
||||||
|
feature that (1) displays an appropriate copyright notice, and (2) |
||||||
|
tells the user that there is no warranty for the work (except to the |
||||||
|
extent that warranties are provided), that licensees may convey the |
||||||
|
work under this License, and how to view a copy of this License. If |
||||||
|
the interface presents a list of user commands or options, such as a |
||||||
|
menu, a prominent item in the list meets this criterion. |
||||||
|
|
||||||
|
1. Source Code. |
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work |
||||||
|
for making modifications to it. "Object code" means any non-source |
||||||
|
form of a work. |
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official |
||||||
|
standard defined by a recognized standards body, or, in the case of |
||||||
|
interfaces specified for a particular programming language, one that |
||||||
|
is widely used among developers working in that language. |
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other |
||||||
|
than the work as a whole, that (a) is included in the normal form of |
||||||
|
packaging a Major Component, but which is not part of that Major |
||||||
|
Component, and (b) serves only to enable use of the work with that |
||||||
|
Major Component, or to implement a Standard Interface for which an |
||||||
|
implementation is available to the public in source code form. A |
||||||
|
"Major Component", in this context, means a major essential component |
||||||
|
(kernel, window system, and so on) of the specific operating system |
||||||
|
(if any) on which the executable work runs, or a compiler used to |
||||||
|
produce the work, or an object code interpreter used to run it. |
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all |
||||||
|
the source code needed to generate, install, and (for an executable |
||||||
|
work) run the object code and to modify the work, including scripts to |
||||||
|
control those activities. However, it does not include the work's |
||||||
|
System Libraries, or general-purpose tools or generally available free |
||||||
|
programs which are used unmodified in performing those activities but |
||||||
|
which are not part of the work. For example, Corresponding Source |
||||||
|
includes interface definition files associated with source files for |
||||||
|
the work, and the source code for shared libraries and dynamically |
||||||
|
linked subprograms that the work is specifically designed to require, |
||||||
|
such as by intimate data communication or control flow between those |
||||||
|
subprograms and other parts of the work. |
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users |
||||||
|
can regenerate automatically from other parts of the Corresponding |
||||||
|
Source. |
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that |
||||||
|
same work. |
||||||
|
|
||||||
|
2. Basic Permissions. |
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of |
||||||
|
copyright on the Program, and are irrevocable provided the stated |
||||||
|
conditions are met. This License explicitly affirms your unlimited |
||||||
|
permission to run the unmodified Program. The output from running a |
||||||
|
covered work is covered by this License only if the output, given its |
||||||
|
content, constitutes a covered work. This License acknowledges your |
||||||
|
rights of fair use or other equivalent, as provided by copyright law. |
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not |
||||||
|
convey, without conditions so long as your license otherwise remains |
||||||
|
in force. You may convey covered works to others for the sole purpose |
||||||
|
of having them make modifications exclusively for you, or provide you |
||||||
|
with facilities for running those works, provided that you comply with |
||||||
|
the terms of this License in conveying all material for which you do |
||||||
|
not control copyright. Those thus making or running the covered works |
||||||
|
for you must do so exclusively on your behalf, under your direction |
||||||
|
and control, on terms that prohibit them from making any copies of |
||||||
|
your copyrighted material outside their relationship with you. |
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under |
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10 |
||||||
|
makes it unnecessary. |
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law. |
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological |
||||||
|
measure under any applicable law fulfilling obligations under article |
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or |
||||||
|
similar laws prohibiting or restricting circumvention of such |
||||||
|
measures. |
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid |
||||||
|
circumvention of technological measures to the extent such circumvention |
||||||
|
is effected by exercising rights under this License with respect to |
||||||
|
the covered work, and you disclaim any intention to limit operation or |
||||||
|
modification of the work as a means of enforcing, against the work's |
||||||
|
users, your or third parties' legal rights to forbid circumvention of |
||||||
|
technological measures. |
||||||
|
|
||||||
|
4. Conveying Verbatim Copies. |
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you |
||||||
|
receive it, in any medium, provided that you conspicuously and |
||||||
|
appropriately publish on each copy an appropriate copyright notice; |
||||||
|
keep intact all notices stating that this License and any |
||||||
|
non-permissive terms added in accord with section 7 apply to the code; |
||||||
|
keep intact all notices of the absence of any warranty; and give all |
||||||
|
recipients a copy of this License along with the Program. |
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey, |
||||||
|
and you may offer support or warranty protection for a fee. |
||||||
|
|
||||||
|
5. Conveying Modified Source Versions. |
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to |
||||||
|
produce it from the Program, in the form of source code under the |
||||||
|
terms of section 4, provided that you also meet all of these conditions: |
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified |
||||||
|
it, and giving a relevant date. |
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is |
||||||
|
released under this License and any conditions added under section |
||||||
|
7. This requirement modifies the requirement in section 4 to |
||||||
|
"keep intact all notices". |
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this |
||||||
|
License to anyone who comes into possession of a copy. This |
||||||
|
License will therefore apply, along with any applicable section 7 |
||||||
|
additional terms, to the whole of the work, and all its parts, |
||||||
|
regardless of how they are packaged. This License gives no |
||||||
|
permission to license the work in any other way, but it does not |
||||||
|
invalidate such permission if you have separately received it. |
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display |
||||||
|
Appropriate Legal Notices; however, if the Program has interactive |
||||||
|
interfaces that do not display Appropriate Legal Notices, your |
||||||
|
work need not make them do so. |
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent |
||||||
|
works, which are not by their nature extensions of the covered work, |
||||||
|
and which are not combined with it such as to form a larger program, |
||||||
|
in or on a volume of a storage or distribution medium, is called an |
||||||
|
"aggregate" if the compilation and its resulting copyright are not |
||||||
|
used to limit the access or legal rights of the compilation's users |
||||||
|
beyond what the individual works permit. Inclusion of a covered work |
||||||
|
in an aggregate does not cause this License to apply to the other |
||||||
|
parts of the aggregate. |
||||||
|
|
||||||
|
6. Conveying Non-Source Forms. |
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms |
||||||
|
of sections 4 and 5, provided that you also convey the |
||||||
|
machine-readable Corresponding Source under the terms of this License, |
||||||
|
in one of these ways: |
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product |
||||||
|
(including a physical distribution medium), accompanied by the |
||||||
|
Corresponding Source fixed on a durable physical medium |
||||||
|
customarily used for software interchange. |
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product |
||||||
|
(including a physical distribution medium), accompanied by a |
||||||
|
written offer, valid for at least three years and valid for as |
||||||
|
long as you offer spare parts or customer support for that product |
||||||
|
model, to give anyone who possesses the object code either (1) a |
||||||
|
copy of the Corresponding Source for all the software in the |
||||||
|
product that is covered by this License, on a durable physical |
||||||
|
medium customarily used for software interchange, for a price no |
||||||
|
more than your reasonable cost of physically performing this |
||||||
|
conveying of source, or (2) access to copy the |
||||||
|
Corresponding Source from a network server at no charge. |
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the |
||||||
|
written offer to provide the Corresponding Source. This |
||||||
|
alternative is allowed only occasionally and noncommercially, and |
||||||
|
only if you received the object code with such an offer, in accord |
||||||
|
with subsection 6b. |
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated |
||||||
|
place (gratis or for a charge), and offer equivalent access to the |
||||||
|
Corresponding Source in the same way through the same place at no |
||||||
|
further charge. You need not require recipients to copy the |
||||||
|
Corresponding Source along with the object code. If the place to |
||||||
|
copy the object code is a network server, the Corresponding Source |
||||||
|
may be on a different server (operated by you or a third party) |
||||||
|
that supports equivalent copying facilities, provided you maintain |
||||||
|
clear directions next to the object code saying where to find the |
||||||
|
Corresponding Source. Regardless of what server hosts the |
||||||
|
Corresponding Source, you remain obligated to ensure that it is |
||||||
|
available for as long as needed to satisfy these requirements. |
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided |
||||||
|
you inform other peers where the object code and Corresponding |
||||||
|
Source of the work are being offered to the general public at no |
||||||
|
charge under subsection 6d. |
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded |
||||||
|
from the Corresponding Source as a System Library, need not be |
||||||
|
included in conveying the object code work. |
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any |
||||||
|
tangible personal property which is normally used for personal, family, |
||||||
|
or household purposes, or (2) anything designed or sold for incorporation |
||||||
|
into a dwelling. In determining whether a product is a consumer product, |
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular |
||||||
|
product received by a particular user, "normally used" refers to a |
||||||
|
typical or common use of that class of product, regardless of the status |
||||||
|
of the particular user or of the way in which the particular user |
||||||
|
actually uses, or expects or is expected to use, the product. A product |
||||||
|
is a consumer product regardless of whether the product has substantial |
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent |
||||||
|
the only significant mode of use of the product. |
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods, |
||||||
|
procedures, authorization keys, or other information required to install |
||||||
|
and execute modified versions of a covered work in that User Product from |
||||||
|
a modified version of its Corresponding Source. The information must |
||||||
|
suffice to ensure that the continued functioning of the modified object |
||||||
|
code is in no case prevented or interfered with solely because |
||||||
|
modification has been made. |
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or |
||||||
|
specifically for use in, a User Product, and the conveying occurs as |
||||||
|
part of a transaction in which the right of possession and use of the |
||||||
|
User Product is transferred to the recipient in perpetuity or for a |
||||||
|
fixed term (regardless of how the transaction is characterized), the |
||||||
|
Corresponding Source conveyed under this section must be accompanied |
||||||
|
by the Installation Information. But this requirement does not apply |
||||||
|
if neither you nor any third party retains the ability to install |
||||||
|
modified object code on the User Product (for example, the work has |
||||||
|
been installed in ROM). |
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a |
||||||
|
requirement to continue to provide support service, warranty, or updates |
||||||
|
for a work that has been modified or installed by the recipient, or for |
||||||
|
the User Product in which it has been modified or installed. Access to a |
||||||
|
network may be denied when the modification itself materially and |
||||||
|
adversely affects the operation of the network or violates the rules and |
||||||
|
protocols for communication across the network. |
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided, |
||||||
|
in accord with this section must be in a format that is publicly |
||||||
|
documented (and with an implementation available to the public in |
||||||
|
source code form), and must require no special password or key for |
||||||
|
unpacking, reading or copying. |
||||||
|
|
||||||
|
7. Additional Terms. |
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this |
||||||
|
License by making exceptions from one or more of its conditions. |
||||||
|
Additional permissions that are applicable to the entire Program shall |
||||||
|
be treated as though they were included in this License, to the extent |
||||||
|
that they are valid under applicable law. If additional permissions |
||||||
|
apply only to part of the Program, that part may be used separately |
||||||
|
under those permissions, but the entire Program remains governed by |
||||||
|
this License without regard to the additional permissions. |
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option |
||||||
|
remove any additional permissions from that copy, or from any part of |
||||||
|
it. (Additional permissions may be written to require their own |
||||||
|
removal in certain cases when you modify the work.) You may place |
||||||
|
additional permissions on material, added by you to a covered work, |
||||||
|
for which you have or can give appropriate copyright permission. |
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you |
||||||
|
add to a covered work, you may (if authorized by the copyright holders of |
||||||
|
that material) supplement the terms of this License with terms: |
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the |
||||||
|
terms of sections 15 and 16 of this License; or |
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or |
||||||
|
author attributions in that material or in the Appropriate Legal |
||||||
|
Notices displayed by works containing it; or |
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or |
||||||
|
requiring that modified versions of such material be marked in |
||||||
|
reasonable ways as different from the original version; or |
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or |
||||||
|
authors of the material; or |
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some |
||||||
|
trade names, trademarks, or service marks; or |
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that |
||||||
|
material by anyone who conveys the material (or modified versions of |
||||||
|
it) with contractual assumptions of liability to the recipient, for |
||||||
|
any liability that these contractual assumptions directly impose on |
||||||
|
those licensors and authors. |
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further |
||||||
|
restrictions" within the meaning of section 10. If the Program as you |
||||||
|
received it, or any part of it, contains a notice stating that it is |
||||||
|
governed by this License along with a term that is a further |
||||||
|
restriction, you may remove that term. If a license document contains |
||||||
|
a further restriction but permits relicensing or conveying under this |
||||||
|
License, you may add to a covered work material governed by the terms |
||||||
|
of that license document, provided that the further restriction does |
||||||
|
not survive such relicensing or conveying. |
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you |
||||||
|
must place, in the relevant source files, a statement of the |
||||||
|
additional terms that apply to those files, or a notice indicating |
||||||
|
where to find the applicable terms. |
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the |
||||||
|
form of a separately written license, or stated as exceptions; |
||||||
|
the above requirements apply either way. |
||||||
|
|
||||||
|
8. Termination. |
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly |
||||||
|
provided under this License. Any attempt otherwise to propagate or |
||||||
|
modify it is void, and will automatically terminate your rights under |
||||||
|
this License (including any patent licenses granted under the third |
||||||
|
paragraph of section 11). |
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your |
||||||
|
license from a particular copyright holder is reinstated (a) |
||||||
|
provisionally, unless and until the copyright holder explicitly and |
||||||
|
finally terminates your license, and (b) permanently, if the copyright |
||||||
|
holder fails to notify you of the violation by some reasonable means |
||||||
|
prior to 60 days after the cessation. |
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is |
||||||
|
reinstated permanently if the copyright holder notifies you of the |
||||||
|
violation by some reasonable means, this is the first time you have |
||||||
|
received notice of violation of this License (for any work) from that |
||||||
|
copyright holder, and you cure the violation prior to 30 days after |
||||||
|
your receipt of the notice. |
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the |
||||||
|
licenses of parties who have received copies or rights from you under |
||||||
|
this License. If your rights have been terminated and not permanently |
||||||
|
reinstated, you do not qualify to receive new licenses for the same |
||||||
|
material under section 10. |
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies. |
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or |
||||||
|
run a copy of the Program. Ancillary propagation of a covered work |
||||||
|
occurring solely as a consequence of using peer-to-peer transmission |
||||||
|
to receive a copy likewise does not require acceptance. However, |
||||||
|
nothing other than this License grants you permission to propagate or |
||||||
|
modify any covered work. These actions infringe copyright if you do |
||||||
|
not accept this License. Therefore, by modifying or propagating a |
||||||
|
covered work, you indicate your acceptance of this License to do so. |
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients. |
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically |
||||||
|
receives a license from the original licensors, to run, modify and |
||||||
|
propagate that work, subject to this License. You are not responsible |
||||||
|
for enforcing compliance by third parties with this License. |
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an |
||||||
|
organization, or substantially all assets of one, or subdividing an |
||||||
|
organization, or merging organizations. If propagation of a covered |
||||||
|
work results from an entity transaction, each party to that |
||||||
|
transaction who receives a copy of the work also receives whatever |
||||||
|
licenses to the work the party's predecessor in interest had or could |
||||||
|
give under the previous paragraph, plus a right to possession of the |
||||||
|
Corresponding Source of the work from the predecessor in interest, if |
||||||
|
the predecessor has it or can get it with reasonable efforts. |
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the |
||||||
|
rights granted or affirmed under this License. For example, you may |
||||||
|
not impose a license fee, royalty, or other charge for exercise of |
||||||
|
rights granted under this License, and you may not initiate litigation |
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that |
||||||
|
any patent claim is infringed by making, using, selling, offering for |
||||||
|
sale, or importing the Program or any portion of it. |
||||||
|
|
||||||
|
11. Patents. |
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this |
||||||
|
License of the Program or a work on which the Program is based. The |
||||||
|
work thus licensed is called the contributor's "contributor version". |
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims |
||||||
|
owned or controlled by the contributor, whether already acquired or |
||||||
|
hereafter acquired, that would be infringed by some manner, permitted |
||||||
|
by this License, of making, using, or selling its contributor version, |
||||||
|
but do not include claims that would be infringed only as a |
||||||
|
consequence of further modification of the contributor version. For |
||||||
|
purposes of this definition, "control" includes the right to grant |
||||||
|
patent sublicenses in a manner consistent with the requirements of |
||||||
|
this License. |
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free |
||||||
|
patent license under the contributor's essential patent claims, to |
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and |
||||||
|
propagate the contents of its contributor version. |
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express |
||||||
|
agreement or commitment, however denominated, not to enforce a patent |
||||||
|
(such as an express permission to practice a patent or covenant not to |
||||||
|
sue for patent infringement). To "grant" such a patent license to a |
||||||
|
party means to make such an agreement or commitment not to enforce a |
||||||
|
patent against the party. |
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license, |
||||||
|
and the Corresponding Source of the work is not available for anyone |
||||||
|
to copy, free of charge and under the terms of this License, through a |
||||||
|
publicly available network server or other readily accessible means, |
||||||
|
then you must either (1) cause the Corresponding Source to be so |
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the |
||||||
|
patent license for this particular work, or (3) arrange, in a manner |
||||||
|
consistent with the requirements of this License, to extend the patent |
||||||
|
license to downstream recipients. "Knowingly relying" means you have |
||||||
|
actual knowledge that, but for the patent license, your conveying the |
||||||
|
covered work in a country, or your recipient's use of the covered work |
||||||
|
in a country, would infringe one or more identifiable patents in that |
||||||
|
country that you have reason to believe are valid. |
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or |
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a |
||||||
|
covered work, and grant a patent license to some of the parties |
||||||
|
receiving the covered work authorizing them to use, propagate, modify |
||||||
|
or convey a specific copy of the covered work, then the patent license |
||||||
|
you grant is automatically extended to all recipients of the covered |
||||||
|
work and works based on it. |
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within |
||||||
|
the scope of its coverage, prohibits the exercise of, or is |
||||||
|
conditioned on the non-exercise of one or more of the rights that are |
||||||
|
specifically granted under this License. You may not convey a covered |
||||||
|
work if you are a party to an arrangement with a third party that is |
||||||
|
in the business of distributing software, under which you make payment |
||||||
|
to the third party based on the extent of your activity of conveying |
||||||
|
the work, and under which the third party grants, to any of the |
||||||
|
parties who would receive the covered work from you, a discriminatory |
||||||
|
patent license (a) in connection with copies of the covered work |
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily |
||||||
|
for and in connection with specific products or compilations that |
||||||
|
contain the covered work, unless you entered into that arrangement, |
||||||
|
or that patent license was granted, prior to 28 March 2007. |
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting |
||||||
|
any implied license or other defenses to infringement that may |
||||||
|
otherwise be available to you under applicable patent law. |
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom. |
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or |
||||||
|
otherwise) that contradict the conditions of this License, they do not |
||||||
|
excuse you from the conditions of this License. If you cannot convey a |
||||||
|
covered work so as to satisfy simultaneously your obligations under this |
||||||
|
License and any other pertinent obligations, then as a consequence you may |
||||||
|
not convey it at all. For example, if you agree to terms that obligate you |
||||||
|
to collect a royalty for further conveying from those to whom you convey |
||||||
|
the Program, the only way you could satisfy both those terms and this |
||||||
|
License would be to refrain entirely from conveying the Program. |
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License. |
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the |
||||||
|
Program, your modified version must prominently offer all users |
||||||
|
interacting with it remotely through a computer network (if your version |
||||||
|
supports such interaction) an opportunity to receive the Corresponding |
||||||
|
Source of your version by providing access to the Corresponding Source |
||||||
|
from a network server at no charge, through some standard or customary |
||||||
|
means of facilitating copying of software. This Corresponding Source |
||||||
|
shall include the Corresponding Source for any work covered by version 3 |
||||||
|
of the GNU General Public License that is incorporated pursuant to the |
||||||
|
following paragraph. |
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have |
||||||
|
permission to link or combine any covered work with a work licensed |
||||||
|
under version 3 of the GNU General Public License into a single |
||||||
|
combined work, and to convey the resulting work. The terms of this |
||||||
|
License will continue to apply to the part which is the covered work, |
||||||
|
but the work with which it is combined will remain governed by version |
||||||
|
3 of the GNU General Public License. |
||||||
|
|
||||||
|
14. Revised Versions of this License. |
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of |
||||||
|
the GNU Affero General Public License from time to time. Such new versions |
||||||
|
will be similar in spirit to the present version, but may differ in detail to |
||||||
|
address new problems or concerns. |
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the |
||||||
|
Program specifies that a certain numbered version of the GNU Affero General |
||||||
|
Public License "or any later version" applies to it, you have the |
||||||
|
option of following the terms and conditions either of that numbered |
||||||
|
version or of any later version published by the Free Software |
||||||
|
Foundation. If the Program does not specify a version number of the |
||||||
|
GNU Affero General Public License, you may choose any version ever published |
||||||
|
by the Free Software Foundation. |
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future |
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's |
||||||
|
public statement of acceptance of a version permanently authorizes you |
||||||
|
to choose that version for the Program. |
||||||
|
|
||||||
|
Later license versions may give you additional or different |
||||||
|
permissions. However, no additional obligations are imposed on any |
||||||
|
author or copyright holder as a result of your choosing to follow a |
||||||
|
later version. |
||||||
|
|
||||||
|
15. Disclaimer of Warranty. |
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY |
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT |
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY |
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, |
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM |
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF |
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION. |
||||||
|
|
||||||
|
16. Limitation of Liability. |
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING |
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS |
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY |
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE |
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF |
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD |
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), |
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF |
||||||
|
SUCH DAMAGES. |
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16. |
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided |
||||||
|
above cannot be given local legal effect according to their terms, |
||||||
|
reviewing courts shall apply local law that most closely approximates |
||||||
|
an absolute waiver of all civil liability in connection with the |
||||||
|
Program, unless a warranty or assumption of liability accompanies a |
||||||
|
copy of the Program in return for a fee. |
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS |
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs |
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest |
||||||
|
possible use to the public, the best way to achieve this is to make it |
||||||
|
free software which everyone can redistribute and change under these terms. |
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest |
||||||
|
to attach them to the start of each source file to most effectively |
||||||
|
state the exclusion of warranty; and each file should have at least |
||||||
|
the "copyright" line and a pointer to where the full notice is found. |
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.> |
||||||
|
|
||||||
|
Copyright (C) 2026 Lasse Edfast |
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify |
||||||
|
it under the terms of the GNU Affero General Public License as published by |
||||||
|
the Free Software Foundation, either version 3 of the License, or |
||||||
|
(at your option) any later version. |
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful, |
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||||
|
GNU Affero General Public License for more details. |
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License |
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>. |
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail. |
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer |
||||||
|
network, you should also make sure that it provides a way for users to |
||||||
|
get its source. For example, if your program is a web application, its |
||||||
|
interface could display a "Source" link that leads users to an archive |
||||||
|
of the code. There are many ways you could offer source, and different |
||||||
|
solutions will be better for different programs; see section 13 for the |
||||||
|
specific requirements. |
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school, |
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary. |
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see |
||||||
|
<http://www.gnu.org/licenses/>. |
||||||
@ -1,28 +1,47 @@ |
|||||||
.PHONY: frontend backend reload nginx install-sync mcp |
.PHONY: help setup dev backend frontend build test lint schema mcp check-fork-divergence |
||||||
|
|
||||||
# install deps and build the React app
|
help: |
||||||
frontend: |
@grep -E '^[a-z-]+:.*?## ' $(MAKEFILE_LIST) | awk -F':.*?## ' '{printf " \033[36m%-22s\033[0m %s\n", $$1, $$2}'
|
||||||
cd frontend && npm install && npm run build
|
|
||||||
|
setup: ## Create the venv and install Python + frontend dependencies
|
||||||
|
python3 -m venv .venv
|
||||||
|
.venv/bin/pip install -e ".[dev]"
|
||||||
|
cd frontend && npm install
|
||||||
|
@test -f .env || (cp .env.example .env && echo "Created .env — fill it in before running.")
|
||||||
|
|
||||||
# start FastAPI backend
|
dev: ## Run the API with reload (frontend: `cd frontend && npm run dev`)
|
||||||
backend: |
.venv/bin/uvicorn backend.app:app --reload --port 8000
|
||||||
uvicorn backend.app:app --reload --port 8000
|
|
||||||
|
|
||||||
# reload nginx after config or build changes
|
backend: dev |
||||||
nginx: |
|
||||||
sudo systemctl reload nginx
|
frontend: ## Build the production frontend bundle
|
||||||
|
cd frontend && npm install && npm run build
|
||||||
|
|
||||||
# build everything and reload nginx
|
build: frontend ## Alias for frontend
|
||||||
all: frontend nginx |
|
||||||
|
|
||||||
# start MCP server (HTTP transport on port 8001)
|
schema: ## Apply schema.sql to the configured database
|
||||||
mcp: |
@set -a; . ./.env; set +a; \
|
||||||
|
psql -h "$$PG_HOST" -U "$$PG_USER" -d "$$PG_DB" -v ON_ERROR_STOP=1 -f _postgres/schema.sql
|
||||||
|
|
||||||
|
mcp: ## Run the MCP server (optional; needs the `mcp` extra)
|
||||||
.venv/bin/python riksdagen_mcp/server.py
|
.venv/bin/python riksdagen_mcp/server.py
|
||||||
|
|
||||||
# install and enable the daily sync timer
|
test: ## Run the test suite
|
||||||
install-sync: |
.venv/bin/pytest -q
|
||||||
sudo cp etc/riksdagen-sync.service /etc/systemd/system/
|
|
||||||
sudo cp etc/riksdagen-sync.timer /etc/systemd/system/
|
lint: ## Lint Python and type-check the frontend
|
||||||
sudo systemctl daemon-reload
|
.venv/bin/ruff check .
|
||||||
sudo systemctl enable --now riksdagen-sync.timer
|
cd frontend && npx tsc --noEmit
|
||||||
@echo "Timer installed. Check status with: systemctl list-timers | grep riksdagen"
|
|
||||||
|
# For a production fork: everything deployment-specific belongs in deploy/prod/, a
|
||||||
|
# path upstream never writes to. If this reports anything else, the layering has
|
||||||
|
# sprung a leak and the next upstream merge will conflict.
|
||||||
|
check-fork-divergence: ## Verify the fork differs from upstream only under deploy/prod/
|
||||||
|
@git fetch upstream --quiet 2>/dev/null || { echo "No 'upstream' remote configured."; exit 1; }
|
||||||
|
@diff=$$(git diff --stat upstream/main..HEAD -- . ':!deploy/prod'); \
|
||||||
|
if [ -n "$$diff" ]; then \
|
||||||
|
echo "$$diff"; \
|
||||||
|
echo "Fork diverges from upstream outside deploy/prod/."; exit 1; \
|
||||||
|
else \
|
||||||
|
echo "Fork is clean: no differences outside deploy/prod/."; \
|
||||||
|
fi
|
||||||
|
|||||||
@ -0,0 +1,127 @@ |
|||||||
|
# plenum |
||||||
|
|
||||||
|
Search, chat and research over what a parliament actually said. |
||||||
|
|
||||||
|
plenum ingests a parliament's open data — speeches from the chamber, motions and |
||||||
|
other member-submitted documents, and the register of members — into PostgreSQL |
||||||
|
with full-text and vector indexes, then puts three things on top: |
||||||
|
|
||||||
|
- **Search.** Full-text search with phrase, prefix, boolean and exclusion syntax, |
||||||
|
filterable by party, year, speaker and debate type. |
||||||
|
- **Chat.** A retrieval-augmented assistant that answers from the corpus and cites |
||||||
|
the speeches and documents it used. Every claim links back to a source. |
||||||
|
- **Deep research.** A background agent that proposes research threads, digs into |
||||||
|
each one, and produces a report with citations. |
||||||
|
|
||||||
|
It runs in production as [rixdagen.se](https://rixdagen.se) over the Swedish |
||||||
|
Riksdag. The Swedish configuration ships here as the worked example; everything |
||||||
|
country-specific lives in one file. |
||||||
|
|
||||||
|
> **Grounding is the point.** This is a tool for journalists and researchers, so an |
||||||
|
> answer that cannot be traced to a source is a bug, not a rough edge. If you change |
||||||
|
> the prompts or the retrieval logic, keep that property. |
||||||
|
|
||||||
|
## How it stays country-agnostic |
||||||
|
|
||||||
|
| Concern | Where it lives | |
||||||
|
|---|---| |
||||||
|
| Parties, colours, chamber activity types, vocabulary, ID shapes, source URLs | `parliament.yaml` | |
||||||
|
| System prompts, tool descriptions | `prompts/<lang>/**.md` | |
||||||
|
| Site copy | `content/<lang>/*.md` | |
||||||
|
| Knowledge of one parliament's JSON shape | `ingest/adapters/<name>.py` | |
||||||
|
| Everything else | country-neutral | |
||||||
|
|
||||||
|
Adapting to another parliament means writing a config file, an ingest adapter, and a |
||||||
|
set of prompts in your language — not editing the application. See |
||||||
|
[docs/PORTING.md](docs/PORTING.md). |
||||||
|
|
||||||
|
The database schema still uses Swedish column names (`anforandetext`, `intressent_id`, |
||||||
|
`yrkanden`). Renaming those to neutral English is planned and tracked; until then, |
||||||
|
[docs/SCHEMA.md](docs/SCHEMA.md) gives the translations. |
||||||
|
|
||||||
|
## Requirements |
||||||
|
|
||||||
|
- PostgreSQL 14+ with [pgvector](https://github.com/pgvector/pgvector) and `pg_trgm` |
||||||
|
- Python 3.10+ |
||||||
|
- Node 18+ (frontend build) |
||||||
|
- An OpenAI-compatible chat endpoint and an OpenAI-compatible embeddings endpoint. |
||||||
|
Self-hosted vLLM, OpenAI, OpenRouter, Berget and Gemini's compatibility endpoint |
||||||
|
all work; see `providers.template.yaml`. |
||||||
|
|
||||||
|
## Quickstart |
||||||
|
|
||||||
|
```bash |
||||||
|
git clone https://git.edfast.se/plenum/plenum && cd plenum |
||||||
|
cp .env.example .env # then fill in database and model settings |
||||||
|
python -m venv .venv && .venv/bin/pip install -e ".[dev]" |
||||||
|
``` |
||||||
|
|
||||||
|
Create the database and apply the schema: |
||||||
|
|
||||||
|
```bash |
||||||
|
createdb plenum && psql -d plenum -c 'CREATE EXTENSION vector; CREATE EXTENSION pg_trgm;' |
||||||
|
psql -d plenum -c "ALTER DATABASE plenum SET app.fts_config = 'swedish';" |
||||||
|
psql -d plenum -f _postgres/schema.sql |
||||||
|
``` |
||||||
|
|
||||||
|
Fetch and index data. This downloads several GB and takes hours; start with one range: |
||||||
|
|
||||||
|
```bash |
||||||
|
python -m ingest.cli fetch --source documents --range 2022-2025 |
||||||
|
python -m ingest.cli load --source documents |
||||||
|
python scripts/make_embeddings.py |
||||||
|
``` |
||||||
|
|
||||||
|
Run it: |
||||||
|
|
||||||
|
```bash |
||||||
|
.venv/bin/uvicorn backend.app:app --reload # API on :8000 |
||||||
|
cd frontend && npm install && npm run dev # UI on :5173, proxying /api |
||||||
|
``` |
||||||
|
|
||||||
|
## Layout |
||||||
|
|
||||||
|
``` |
||||||
|
backend/ FastAPI app: routes, search, chat, deep research |
||||||
|
services/ chat orchestration, tools the model can call, retrieval |
||||||
|
services/research/ the background research agent |
||||||
|
packages/llm/ provider-agnostic LLM client and the tool registry |
||||||
|
_postgres/ schema, migrations, connection pool |
||||||
|
ingest/ fetch -> adapt -> upsert -> chunk -> embed |
||||||
|
prompts/ system prompts and tool descriptions, per language |
||||||
|
parliament.yaml everything specific to one parliament |
||||||
|
frontend/ React + TypeScript + Vite |
||||||
|
deploy/examples/ systemd units and an nginx site, with placeholders |
||||||
|
``` |
||||||
|
|
||||||
|
## Configuration |
||||||
|
|
||||||
|
All settings are environment variables, documented in `.env.example`. Two paths let a |
||||||
|
deployment keep its own values outside the repository entirely: |
||||||
|
|
||||||
|
- `PARLIAMENT_CONFIG` — path to a `parliament.yaml` elsewhere on disk |
||||||
|
- `PROMPTS_DIR` — path to a prompt tree elsewhere on disk |
||||||
|
|
||||||
|
Set `PROMPTS_RELOAD=1` in development to re-read prompt files on every call. |
||||||
|
|
||||||
|
## Security |
||||||
|
|
||||||
|
The `database_query` tool executes model-authored SQL. Give it a database role with |
||||||
|
`SELECT` only — the application does not currently enforce that itself, and corpus |
||||||
|
text reaches the model's context, so treat it as untrusted input. See |
||||||
|
[SECURITY.md](SECURITY.md). |
||||||
|
|
||||||
|
## License |
||||||
|
|
||||||
|
AGPL-3.0-or-later. If you run a modified version as a network service, you must offer |
||||||
|
its source to users of that service. |
||||||
|
|
||||||
|
If AGPL does not work for your organisation, ask — I am open to granting other terms |
||||||
|
for newsrooms and public-interest projects. Contact details are in the repository |
||||||
|
metadata. |
||||||
|
|
||||||
|
## Acknowledgements |
||||||
|
|
||||||
|
Swedish parliamentary data comes from [data.riksdagen.se](https://data.riksdagen.se) |
||||||
|
under the Riksdag's open-data terms. plenum is not affiliated with or endorsed by the |
||||||
|
Swedish Riksdag. |
||||||
@ -0,0 +1,53 @@ |
|||||||
|
# Security |
||||||
|
|
||||||
|
## Reporting a vulnerability |
||||||
|
|
||||||
|
Open a private issue on the repository, or contact the maintainer directly rather |
||||||
|
than filing a public issue. Please allow reasonable time for a fix before disclosing. |
||||||
|
|
||||||
|
## Known issue: `database_query` executes model-authored SQL |
||||||
|
|
||||||
|
The `database_query` tool lets the model write and run SQL so it can answer |
||||||
|
aggregate questions ("how many speeches per party mentioned X?"). The SQL is passed |
||||||
|
to the database as written. There is currently **no `SELECT`-only enforcement in the |
||||||
|
application**. |
||||||
|
|
||||||
|
This matters more than it might appear, because the corpus itself reaches the model's |
||||||
|
context. Speech and document text is fetched and shown to the model, so anyone who |
||||||
|
can get text into the parliament's record — which, in a parliament, is the point — |
||||||
|
can attempt a prompt injection. |
||||||
|
|
||||||
|
**Run plenum against a database role that only has `SELECT`.** The application does |
||||||
|
not do this for you: |
||||||
|
|
||||||
|
```sql |
||||||
|
CREATE ROLE plenum_ro LOGIN PASSWORD '...'; |
||||||
|
GRANT CONNECT ON DATABASE plenum TO plenum_ro; |
||||||
|
GRANT USAGE ON SCHEMA public TO plenum_ro; |
||||||
|
GRANT SELECT ON ALL TABLES IN SCHEMA public TO plenum_ro; |
||||||
|
ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT SELECT ON TABLES TO plenum_ro; |
||||||
|
``` |
||||||
|
|
||||||
|
The ingest pipeline needs write access and should use a separate role. |
||||||
|
|
||||||
|
Enforcing this in the application — a read-only transaction plus a statement-type |
||||||
|
check on the tool path — is tracked and intended. |
||||||
|
|
||||||
|
## API keys |
||||||
|
|
||||||
|
Users may supply their own model provider key in the browser. That key is held only |
||||||
|
for the duration of a request, is passed to background research jobs over the child |
||||||
|
process's stdin, and is never written to the database or to logs. The only persisted |
||||||
|
copy is the one the browser encrypts under the user's own password. |
||||||
|
|
||||||
|
Server-managed keys come from environment variables and must never be committed. |
||||||
|
`.gitignore` excludes `.env`, `.env.*`, `providers.yaml`, key material and archives. |
||||||
|
|
||||||
|
## Chat privacy |
||||||
|
|
||||||
|
Signed-in users' chats and research boards are stored encrypted with a key derived |
||||||
|
from their password. The server cannot read them. This means a forgotten password is |
||||||
|
unrecoverable by design. |
||||||
|
|
||||||
|
Conversations are logged for evaluation **only** when the first message begins with |
||||||
|
`TEST `. Ordinary conversations are never written to the evaluation tables. |
||||||
@ -0,0 +1,103 @@ |
|||||||
|
# Porting plenum to another parliament |
||||||
|
|
||||||
|
Four things are country-specific: a configuration file, an ingest adapter, a set of |
||||||
|
prompts, and the UI language. Nothing else in the application should need editing — |
||||||
|
if it does, that is a bug worth reporting. |
||||||
|
|
||||||
|
Expect the adapter to be most of the work. Everything else is filling in values. |
||||||
|
|
||||||
|
## 1. `parliament.yaml` |
||||||
|
|
||||||
|
Copy it and change the values. The fields that matter most: |
||||||
|
|
||||||
|
**`language.fts_config`** — a PostgreSQL text-search configuration. Run |
||||||
|
`SELECT cfgname FROM pg_ts_config;` to see what your server has. Postgres ships |
||||||
|
stemmers for around two dozen languages. If yours is not among them, `simple` works |
||||||
|
but gives no stemming, so `kärnkraften` will not match a search for `kärnkraft`. |
||||||
|
Set it on the database too, because the search-vector triggers read it: |
||||||
|
|
||||||
|
```sql |
||||||
|
ALTER DATABASE plenum SET app.fts_config = 'bulgarian'; |
||||||
|
``` |
||||||
|
|
||||||
|
The application refuses to start if the two disagree. That check exists because a |
||||||
|
mismatch does not raise anything — it just makes almost every search return nothing. |
||||||
|
|
||||||
|
**`vocabulary`** — your parliament's own words for a speech, a document, a proposal, |
||||||
|
a committee. These are injected into prompts, so the model reasons in your domain's |
||||||
|
language rather than a translation of Swedish. Words like *yrkande* and *riksmöte* |
||||||
|
have no stable English equivalent, which is exactly why they live here rather than in |
||||||
|
column names. |
||||||
|
|
||||||
|
**`parties`** — code, display name, colour, and whether the party is current. The |
||||||
|
frontend reads these at runtime; there is no per-party CSS to edit. |
||||||
|
|
||||||
|
**`ids`** — the shape of your source's identifiers, with a real example. These are |
||||||
|
templated into prompts so the model can recognise and construct them. |
||||||
|
|
||||||
|
**`activity_types`** — your chamber's debate/activity codes and what they mean. Used |
||||||
|
as filters in the UI and as context in prompts. |
||||||
|
|
||||||
|
## 2. An ingest adapter |
||||||
|
|
||||||
|
Write `ingest/adapters/<yourparliament>.py` and point `sources.adapter` at it. The |
||||||
|
adapter's job is to turn your source's records into the shape the loader expects; it |
||||||
|
is the only place that should know your open-data portal's field names. |
||||||
|
|
||||||
|
Read `ingest/adapters/riksdagen.py` as the worked example. It handles a quirk worth |
||||||
|
anticipating: the Riksdag's XML-to-JSON conversion emits a single child as an object |
||||||
|
and multiple children as an array, so every repeated field needs normalising before |
||||||
|
use. Most portals that started as XML do something similar. |
||||||
|
|
||||||
|
If your parliament publishes bulk archives, `kind: zip-dataset` with a |
||||||
|
`url_template` and a list of ranges is likely enough. If it only has a per-record |
||||||
|
API, you will need a fetch loop in the adapter. |
||||||
|
|
||||||
|
Data quality is usually the real difficulty: missing speaker identifiers, documents |
||||||
|
that exist only as scanned PDFs, and party codes that change when parties merge or |
||||||
|
rename. Decide early whether to correct these on ingest or preserve them as-is and |
||||||
|
handle them in queries. plenum preserves the source values and explains them via |
||||||
|
`decisions` and `document_subtypes`, on the principle that a research tool should not |
||||||
|
silently rewrite the record. |
||||||
|
|
||||||
|
## 3. Prompts |
||||||
|
|
||||||
|
Copy `prompts/sv/` to `prompts/<your-lang>/` and translate. The loader resolves |
||||||
|
`prompts/<prompt_language>/<name>.md` first, then falls back to the shared directory |
||||||
|
and then to `prompts/en/`, so you can port incrementally. |
||||||
|
|
||||||
|
Placeholders use `$name`, not `{name}` — several prompts contain literal JSON braces. |
||||||
|
Available in every prompt: `$parliament_name`, `$fts_config`, `$answer_language`, |
||||||
|
`$preserve_characters`, `$party_codes`, `$date_today`, the `$..._id_example` values, |
||||||
|
and every key from `vocabulary`. |
||||||
|
|
||||||
|
`$preserve_characters` matters more than it looks. It tells the model not to |
||||||
|
transliterate characters your language depends on; searching for `karnkraft` instead |
||||||
|
of `kärnkraft` returns nothing at all. |
||||||
|
|
||||||
|
Set `PROMPTS_RELOAD=1` while you iterate so you are not restarting the server between |
||||||
|
edits. |
||||||
|
|
||||||
|
## 4. UI language |
||||||
|
|
||||||
|
The frontend has no i18n layer yet — Swedish strings are written directly into about |
||||||
|
twenty components. Porting the UI currently means translating those in place. Site |
||||||
|
copy is easier: `content/<lang>/explainer.md` and `limit_warning.md` are served |
||||||
|
through `/api/meta` and need no code change. |
||||||
|
|
||||||
|
## What you do not need to change |
||||||
|
|
||||||
|
The search engine, chat orchestration, tool-calling, citation and attribution |
||||||
|
checking, the deep-research agent, authentication and the encrypted chat store are |
||||||
|
all country-neutral. So is the database schema — although its column names are still |
||||||
|
Swedish (`anforandetext`, `intressent_id`, `yrkanden`). They are just names; nothing |
||||||
|
reads meaning from them. [docs/SCHEMA.md](SCHEMA.md) translates them. |
||||||
|
|
||||||
|
## A caution about scope |
||||||
|
|
||||||
|
plenum assumes a parliament that publishes, as open data, both a transcript of what |
||||||
|
was said in the chamber and the documents members submit, with stable identifiers |
||||||
|
linking them to a register of members. Where that holds — Sweden, the UK, the |
||||||
|
European Parliament, most Nordic and Baltic states — porting is mostly configuration. |
||||||
|
Where it does not, the data model itself may not fit, and you should check that |
||||||
|
before investing in an adapter. |
||||||
@ -0,0 +1,113 @@ |
|||||||
|
# Database schema |
||||||
|
|
||||||
|
The definitive version is [`_postgres/schema.sql`](../_postgres/schema.sql), which is |
||||||
|
verified against the production database. This page explains it. |
||||||
|
|
||||||
|
Column names are still Swedish, inherited from the original Riksdag-only project. |
||||||
|
They are only names — nothing in the application derives meaning from them — but they |
||||||
|
are an obstacle to reading the code, so a rename to neutral English is planned. Until |
||||||
|
then, this is the translation. |
||||||
|
|
||||||
|
## Core tables |
||||||
|
|
||||||
|
### `talks` — speeches in the chamber |
||||||
|
|
||||||
|
One row per speech. The primary key `id` comes from the source; note the separate |
||||||
|
`dok_id`, which identifies the *protocol document* the speech appeared in. |
||||||
|
|
||||||
|
| Column | Meaning | |
||||||
|
|---|---| |
||||||
|
| `id` | Primary key, from the source record's `id` field | |
||||||
|
| `anforande_id` | The source's own UUID, preserved from an earlier key migration | |
||||||
|
| `anforandetext` | The speech text | |
||||||
|
| `avsnittsrubrik` | Heading of the agenda item | |
||||||
|
| `anforande_nummer` | Position within the debate | |
||||||
|
| `kammaraktivitet` | Activity type code; see `activity_types` in `parliament.yaml` | |
||||||
|
| `talare` | Speaker name as printed. Not the presiding officer — "speaker" in the plain sense | |
||||||
|
| `parti` | Party code | |
||||||
|
| `intressent_id` | Person id, references `people` | |
||||||
|
| `datum`, `dok_datum`, `year`, `period` | Date, raw source datetime, calendar year, session start year | |
||||||
|
| `dok_id`, `rel_dok_id`, `dok_nummer`, `hangar_id` | Source document references | |
||||||
|
| `titel` | Debate title | |
||||||
|
| `debate` | Debate grouping key, `"{date}:{index}"` | |
||||||
|
| `replik` | Whether this is a rebuttal (a short right-of-reply intervention) | |
||||||
|
| `summary`, `tags`, `arguments` | LLM-derived | |
||||||
|
| `summary_embedding` | Embedding of `summary`, for debate-level semantic search | |
||||||
|
| `search_vector` | Full-text vector, maintained by trigger | |
||||||
|
|
||||||
|
### `motions` — member-submitted documents |
||||||
|
|
||||||
|
The Swedish *motion* is a formal proposal submitted by members. Each contains one or |
||||||
|
more numbered *yrkanden* — operative demands — which is what people actually search |
||||||
|
and cite. |
||||||
|
|
||||||
|
| Column | Meaning | |
||||||
|
|---|---| |
||||||
|
| `dok_id` | Primary key | |
||||||
|
| `rm` | Session label, e.g. `"2022/23"` (Swedish *riksmöte*) | |
||||||
|
| `beteckning` | Number within the session | |
||||||
|
| `subtyp` | Whether submitted by an individual, a committee group, or a whole party | |
||||||
|
| `organ` | Committee the document was referred to | |
||||||
|
| `titel`, `undertitel`, `text` | Content | |
||||||
|
| `forslag_text` | The proposal texts concatenated — high-signal, weighted separately in search | |
||||||
|
| `parties`, `author_names` | Denormalised authorship, in signing order | |
||||||
|
| `forslag`, `bilagor` | Raw proposal and attachment records from the source | |
||||||
|
| `has_text` | False for documents that exist only as scanned PDFs | |
||||||
|
|
||||||
|
### `motion_yrkanden` — individual proposals within a document |
||||||
|
|
||||||
|
| Column | Meaning | |
||||||
|
|---|---| |
||||||
|
| `lydelse` | The proposal's wording | |
||||||
|
| `utskottet` | The committee's recommendation | |
||||||
|
| `kammaren` | The chamber's decision, e.g. `Bifall` (approved) / `Avslag` (rejected) | |
||||||
|
| `behandlas_i` | Which report handled it | |
||||||
|
|
||||||
|
Values are stored exactly as published and never translated. `decisions:` in |
||||||
|
`parliament.yaml` glosses them so prompts can explain them. |
||||||
|
|
||||||
|
### `people` — the register of members |
||||||
|
|
||||||
|
`intressent_id` is the source's person id and the join key used everywhere. |
||||||
|
`valkrets` is the electoral district; its meaning varies by country — a single-member |
||||||
|
constituency in the UK, a multi-member district in Sweden — and nothing in the code |
||||||
|
assumes either. |
||||||
|
|
||||||
|
### `chunks`, `motion_chunks` — passages with embeddings |
||||||
|
|
||||||
|
Text split into passages, each with a `vector(N)` embedding under an HNSW cosine |
||||||
|
index. `N` must match `embeddings.dimension` in `parliament.yaml`; the application |
||||||
|
checks this at startup because a mismatch otherwise fails deep inside pgvector. |
||||||
|
|
||||||
|
### `debates` — aggregated debates |
||||||
|
|
||||||
|
One row per debate, keyed `"{date}:{index}"`, holding a synthesised summary and the |
||||||
|
list of speeches it covers. |
||||||
|
|
||||||
|
## Application tables |
||||||
|
|
||||||
|
Already country-neutral: `users` and `auth_tokens` (zero-knowledge auth), |
||||||
|
`chat_sessions` and `chat_snapshots` (encrypted chat storage and shared snapshots), |
||||||
|
`research_boards`, `research_threads`, `jobs`, `job_events` (deep research), |
||||||
|
`error_log` and `llm_events` (observability), and the `eval_*` tables. |
||||||
|
|
||||||
|
Two notes: |
||||||
|
|
||||||
|
`chat_snapshots.llm_messages` holds the full tool-call history so a forked snapshot |
||||||
|
resumes with the model's context. Stat cards replay the SQL stored there, which is |
||||||
|
why renaming a column is not a clean break — old SQL has to keep working. |
||||||
|
|
||||||
|
`session_type` is `'general'` or `'mp'`. The `'mp'` value means a chat conducted in |
||||||
|
the persona of a member; read it as "member", not as anything UK-specific. |
||||||
|
|
||||||
|
## Full-text search |
||||||
|
|
||||||
|
Every search vector is built with the configuration named by `language.fts_config`, |
||||||
|
read at runtime from `current_setting('app.fts_config')` inside the triggers. Set it |
||||||
|
per database: |
||||||
|
|
||||||
|
```sql |
||||||
|
ALTER DATABASE plenum SET app.fts_config = 'swedish'; |
||||||
|
``` |
||||||
|
|
||||||
|
This only takes effect for new sessions, so restart the API after changing it. |
||||||
Loading…
Reference in new issue