Use Starlette, uvicorn and websockets; rename Docker files to container ones

Serve neo4j-browser with Starlette and uvicorn (the optional browser extra) instead of a hand-written HTTP server, and handle Bolt over WebSocket with the websockets library's Sans-I/O protocol. Rename Dockerfile, .dockerignore and docker/ to Containerfile, .containerignore and container/. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-21 11:27:25 +02:00
1 parent 3e8e498b56
commit f0fb9ddc74
@@ -0,0 +1,88 @@
+# SPDX-FileCopyrightText: 2026 Bart Broere
+# SPDX-License-Identifier: GPL-3.0-or-later
+"""Make sure every Python distribution in an environment ships its license text.
+
+Most wheels include their license files in ``*.dist-info``. For the ones that
+do not, copy its license files to ``<output>/<name>-<version>/``, taking them
+from ``<vendored>/<name>/`` when present and otherwise from the source
+distribution on PyPI. Run with the interpreter of the environment to inspect:
+``/opt/pgadmin/bin/python collect-python-licenses.py <output> <vendored>``. Only
+the environment's own site-packages are inspected, not the system packages a
+``--system-site-packages`` venv can see: those come with Debian copyright files.
+"""
+
+import io
+import json
+import re
+import sys
+import sysconfig
+import tarfile
+import urllib.request
+import zipfile
+from importlib import metadata
+from pathlib import Path
+
+LICENSE_FILE = re.compile(r"(^|/)(LICEN[CS]E|COPYING|NOTICE|AUTHORS)[^/]*$", re.IGNORECASE)
+
+
+def has_license_file(dist):
+    return any(LICENSE_FILE.search(str(f)) for f in dist.files or [])
+
+
+def sdist_members(name, version):
+    with urllib.request.urlopen(f"https://pypi.org/pypi/{name}/{version}/json", timeout=60) as r:
+        urls = json.load(r)["urls"]
+    sdist = next((u for u in urls if u["packagetype"] == "sdist"), None)
+    if sdist is None:
+        return {}
+    with urllib.request.urlopen(sdist["url"], timeout=120) as r:
+        data = r.read()
+    found = {}
+    if sdist["filename"].endswith(".zip"):
+        with zipfile.ZipFile(io.BytesIO(data)) as z:
+            for n in z.namelist():
+                if n.count("/") == 1 and LICENSE_FILE.search(n):
+                    found[n.split("/", 1)[1]] = z.read(n)
+    else:
+        with tarfile.open(fileobj=io.BytesIO(data)) as t:
+            for m in t.getmembers():
+                if m.isfile() and m.name.count("/") == 1 and LICENSE_FILE.search(m.name):
+                    found[m.name.split("/", 1)[1]] = t.extractfile(m).read()
+    return found
+
+
+def vendored_files(vendored, name):
+    directory = vendored / name
+    if not directory.is_dir():
+        return {}
+    return {f.name: f.read_bytes() for f in directory.iterdir() if f.is_file()}
+
+
+def main(output, vendored):
+    output, vendored = Path(output), Path(vendored)
+    missing = []
+    site_packages = sysconfig.get_paths()["purelib"]
+    for dist in sorted(metadata.distributions(path=[site_packages]), key=lambda d: d.metadata["Name"].lower()):
+        if has_license_file(dist):
+            continue
+        name, version = dist.metadata["Name"], dist.version
+        files = vendored_files(vendored, name)
+        if not files:
+            try:
+                files = sdist_members(name, version)
+            except Exception as e:  # noqa: BLE001 - report and carry on
+                print(f"{name} {version}: could not fetch sdist: {e}", file=sys.stderr)
+        if not files:
+            missing.append(f"{name} {version}")
+            continue
+        target = output / f"{name}-{version}"
+        target.mkdir(parents=True, exist_ok=True)
+        for filename, content in files.items():
+            (target / filename).write_bytes(content)
+        print(f"{name} {version}: added {', '.join(files)}")
+    for item in missing:
+        print(f"WARNING: no license file found for {item}", file=sys.stderr)
+
+
+if __name__ == "__main__":
+    main(sys.argv[1], sys.argv[2])
@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+# SPDX-FileCopyrightText: 2026 Bart Broere
+# SPDX-License-Identifier: GPL-3.0-or-later
+# Prepares a freshly initialised cluster for peo.
+set -euo pipefail
+
+# The bridge connects over 127.0.0.1 with the credentials users log in with, so
+# loopback TCP connections must check passwords. The postgres image trusts them
+# by default; Unix-socket connections (psql inside the container) stay trusted.
+sed -i -E 's/^(host[[:space:]]+[^[:space:]]+[[:space:]]+[^[:space:]]+[[:space:]]+(127\.0\.0\.1\/32|::1\/128)[[:space:]]+)trust/\1scram-sha-256/' \
+    "$PGDATA/pg_hba.conf"
+
+# Create the default AGE graph that neo4j-browser opens on first connect.
+psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" --dbname "${POSTGRES_DB:-$POSTGRES_USER}" \
+    -v graph="${PEO_DEFAULT_GRAPH:-neo4j}" <<'EOSQL'
+LOAD 'age';
+SET search_path = ag_catalog, "$user", public;
+SELECT ag_catalog.create_graph(:'graph')
+WHERE NOT EXISTS (SELECT 1 FROM ag_catalog.ag_graph WHERE name = :'graph');
+EOSQL
@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ali Afshar
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,11 @@
+# Vendored license texts
+
+License files for Python packages that pgAdmin depends on whose PyPI releases do
+not include one. `container/collect-python-licenses.py` copies them into the image.
+Directory names are the PyPI project names.
+
+| Package | License | Source of the text |
+| --- | --- | --- |
+| dnspython | ISC | https://github.com/rthalley/dnspython/blob/v2.9.0/LICENSE |
+| Flask-Principal | MIT | https://github.com/mattupstate/flask-principal/blob/0.4.0/LICENSE |
+| ua-parser-builtins | Apache-2.0 | https://github.com/ua-parser/uap-python/blob/master/LICENSE; it bundles data from uap-core: https://github.com/ua-parser/uap-core/blob/master/LICENSE |
@@ -0,0 +1,35 @@
+ISC License
+
+Copyright (C) Dnspython Contributors
+
+Permission to use, copy, modify, and/or distribute this software for
+any purpose with or without fee is hereby granted, provided that the
+above copyright notice and this permission notice appear in all
+copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
+WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
+PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+
+
+
+Copyright (C) 2001-2017 Nominum, Inc.
+Copyright (C) Google Inc.
+
+Permission to use, copy, modify, and distribute this software and its
+documentation for any purpose with or without fee is hereby granted,
+provided that the above copyright notice and this permission notice
+appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND NOMINUM DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL NOMINUM BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
+OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
@@ -0,0 +1,16 @@
+Apache License, Version 2.0
+===========================
+
+Copyright 2009 Google Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
@@ -0,0 +1,64 @@
+#!/usr/bin/env bash
+# SPDX-FileCopyrightText: 2026 Bart Broere
+# SPDX-License-Identifier: GPL-3.0-or-later
+# Runs PostgreSQL (through the stock postgres entrypoint), the peo bridge and
+# pgAdmin side by side. The container stops when PostgreSQL or the bridge exits;
+# pgAdmin is optional and its failure does not take the others down.
+set -euo pipefail
+
+if [ "${1:-}" != "postgres" ]; then
+    exec docker-entrypoint.sh "$@"
+fi
+
+export PEO_PG_DATABASE="${PEO_PG_DATABASE:-${POSTGRES_DB:-${POSTGRES_USER:-postgres}}}"
+
+start_pgadmin() {
+    local app=/opt/pgadmin/app
+    local email="${PGADMIN_DEFAULT_EMAIL:-admin@example.com}"
+
+    if [ ! -f /var/lib/pgadmin/pgadmin4.db ]; then
+        # First start: create the login user and register the bundled PostgreSQL.
+        cat > /var/lib/pgadmin/servers.json <<EOF
+{"Servers": {"1": {"Name": "peo", "Group": "Servers", "Host": "127.0.0.1", "Port": 5432,
+ "MaintenanceDB": "${PEO_PG_DATABASE}", "Username": "${POSTGRES_USER:-postgres}", "SSLMode": "prefer"}}}
+EOF
+        chown postgres:postgres /var/lib/pgadmin/servers.json
+        PGADMIN_SETUP_EMAIL="$email" \
+            PGADMIN_SETUP_PASSWORD="${PGADMIN_DEFAULT_PASSWORD:-${POSTGRES_PASSWORD:-}}" \
+            gosu postgres /opt/pgadmin/bin/python "$app/setup.py" setup-db \
+            && gosu postgres /opt/pgadmin/bin/python "$app/setup.py" load-servers \
+                /var/lib/pgadmin/servers.json --user "$email" \
+            || { rm -f /var/lib/pgadmin/pgadmin4.db; return 1; }
+    fi
+
+    gosu postgres /opt/pgadmin/bin/gunicorn --bind "0.0.0.0:${PEO_PGADMIN_PORT}" \
+        --workers 1 --threads 25 --timeout 0 --chdir "$app" --log-level warning pgAdmin4:app &
+    pgadmin_pid=$!
+    echo "peo: pgAdmin on http://localhost:${PEO_PGADMIN_PORT}/ (login: $email)"
+}
+
+docker-entrypoint.sh "$@" &
+pg_pid=$!
+
+gosu postgres /opt/peo/venv/bin/peo &
+bridge_pid=$!
+
+pgadmin_pid=
+if [ "${PEO_PGADMIN}" = "true" ]; then
+    start_pgadmin || echo "peo: WARNING: pgAdmin setup failed, continuing without it" >&2
+fi
+
+shutdown() {
+    for pid in "$bridge_pid" $pgadmin_pid "$pg_pid"; do
+        kill -TERM "$pid" 2>/dev/null || true
+    done
+}
+trap shutdown TERM INT
+
+# Wait until PostgreSQL or the bridge exits, then stop everything.
+set +e
+wait -n "$pg_pid" "$bridge_pid"
+status=$?
+shutdown
+wait 2>/dev/null
+exit "$status"
@@ -0,0 +1,20 @@
+# SPDX-FileCopyrightText: 2026 Bart Broere
+# SPDX-License-Identifier: GPL-3.0-or-later
+# pgAdmin settings for the peo image, loaded via CONFIG_DISTRO_FILE_PATH.
+# Paths derived from DATA_DIR in pgAdmin's config.py are computed before this
+# file is applied, so they are all set explicitly here.
+
+DATA_DIR = '/var/lib/pgadmin'
+SQLITE_PATH = DATA_DIR + '/pgadmin4.db'
+SESSION_DB_PATH = DATA_DIR + '/sessions'
+STORAGE_DIR = DATA_DIR + '/storage'
+KERBEROS_CCACHE_DIR = DATA_DIR + '/krbccache'
+AZURE_CREDENTIAL_CACHE_DIR = DATA_DIR + '/azurecredentialcache'
+LOG_FILE = '/dev/null'
+
+SERVER_MODE = True
+UPGRADE_CHECK_ENABLED = False
+
+# From the config_distro.py shipped in the pgadmin4 wheel, which this replaces.
+HELP_PATH = '../../docs/en_US/_build/html/'
+MINIFY_HTML = False