Skip to main content

Open keystone settings control panel — auto-detects installed algovoi packages

Project description

AlgoVoi Keystone Control

Browser panel for installed AlgoVoi keystone packages. Auto-detects which keystone steps are present in the environment, shows their current settings, and lets operators edit them with a pin-gated editor.

Runs over HTTPS out of the box. A self-signed TLS certificate is generated on first start and reused on subsequent runs. Bring your own cert by setting ALGV_TLS_CERT and ALGV_TLS_KEY.

Requirements

  • Python 3.11+, Linux x86_64
  • At least one AlgoVoi keystone package installed in the same environment

Install

pip install algovoi-keystone-control

Run

ALGV_ADMIN_TOKEN=<your-token> algv-keystone

The panel starts on https://0.0.0.0:8077. Open it in a browser and accept the self-signed certificate, or point your browser at a trusted cert with ALGV_TLS_CERT.

Environment variables

Variable Default Purpose
ALGV_ADMIN_TOKEN (required) Bearer token for panel access
ALGV_PORT 8077 Listening port
ALGV_HOST 0.0.0.0 Listening address
ALGV_DATA_DIR ~/.algv/keystone TLS cert and settings storage
ALGV_TLS_CERT (auto) Path to a BYO TLS certificate
ALGV_TLS_KEY (auto) Path to a BYO TLS private key

Systemd example

[Unit]
Description=AlgoVoi Keystone Control
After=network.target

[Service]
User=algv
EnvironmentFile=/etc/algv/keystone.env
ExecStart=/opt/algv/.venv/bin/algv-keystone
Restart=on-failure

[Install]
WantedBy=multi-user.target

/etc/algv/keystone.env (mode 0600):

ALGV_ADMIN_TOKEN=<your-token>
ALGV_DATA_DIR=/var/lib/algv/keystone

API

All endpoints require Authorization: Bearer <token>.

Method Path Description
GET /v1/steps Installed keystone steps and their current settings
GET /v1/all-known All known keystone steps, installed and uninstalled
PUT /v1/settings/{step} Update settings for a step (pin-gated)
POST /v1/reset/{step} Reset a step to defaults (pin-gated)

License

Apache-2.0. See NOTICE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

algovoi_keystone_control-0.1.1-cp311-cp311-manylinux1_x86_64.manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_5_x86_64.whl (250.6 kB view details)

Uploaded CPython 3.11manylinux: glibc 2.17+ x86-64manylinux: glibc 2.5+ x86-64

File details

Details for the file algovoi_keystone_control-0.1.1-cp311-cp311-manylinux1_x86_64.manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_5_x86_64.whl.

File metadata

File hashes

Hashes for algovoi_keystone_control-0.1.1-cp311-cp311-manylinux1_x86_64.manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_5_x86_64.whl
Algorithm Hash digest
SHA256 77bb27a20c6631bcde2b54c12447f28bdc6d745e7c0140dbaf79c0c869820fa8
MD5 1492712a64da97f0a0e78e23c51abba1
BLAKE2b-256 be90073684458ce9d9bf8024fa78924349ae5e44f7e05f0ebcb0212478e945cb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page