Skip to content

About

All in one KnowledgeOS

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Latest commit

 

History

72 Commits

Folders and files

Repository files navigation

ns8-affine

Module id: affine. Images are pinned in build-images.sh and updated through reviewed changes.

Install

add-module ghcr.io/geniusdynamics/affine:latest 1

The command returns the instance id, for example affine1. Use the id NS8 returns.

Configure

api-cli run configure-module --agent module/affine1 --data - <<'EOF'
{
  "host": "affine.example.org",
  "http2https": true,
  "lets_encrypt": false
}
EOF
Parameter Required Type Description
host yes string Host name for the application, like 'affine.domain.org'
lets_encrypt yes boolean Request a valid Let's Encrypt certificate.
http2https yes boolean Redirect all the HTTP requests to HTTPS

Configuration output

get-configuration returns: host, lets_encrypt, http2https.

Images

Image Version
docker.io/pgvector/pgvector pg18
ghcr.io/toeverything/affine 0.26.3
docker.io/redis 8.10.3

Network and access

  • Reserves 1 TCP port(s) on the node. The web application is published through Traefik on the configured host name.
  • Runs rootless.
  • Declares these NS8 authorizations: traefik@node:routeadm.

Backup

The following paths are included in the NS8 backup (imageroot/etc/state-include.conf):

  • state/app.env
  • state/app-db.env
  • state/restore
  • state/pg_dump
  • state/database.env
  • volumes/affine-app
  • volumes/affine-storage
  • volumes/affine-config
  • volumes/db-data-storage

Services

  • affine-app.service
  • affine.service
  • postgresql-app.service
  • redis-app.service

Get the configuration

api-cli run get-configuration --agent module/affine1

Update and uninstall

api-cli run update-module --data '{"module_url":"ghcr.io/geniusdynamics/affine:latest","instances":["affine1"],"force":true}'
remove-module --no-preserve affine1

Testing

Continuous integration:

  • Publish images builds the module image on every push.
  • Test module installs the image on a QEMU NS8 node and runs the Robot Framework suite in tests/. It runs after Publish images succeeds on dev and on main.
  • Build API JSON Schema docs and the security scan run alongside.

The suite installs the module, configures a host name, checks that the web application answers through Traefik, takes UI screenshots and removes the module.

Run it locally with the NS8 standard infrastructure described in the ns8-github-actions README.

Open items

Found by the NS8 module standards check. These must be resolved before a stable release:

  • The module description is still the template text: write a description of at least 60 characters in ui/public/metadata.json

Upstream

Application documentation: https://docs.affine.com/

License

GPL-3.0-or-later. See LICENSE.

About

All in one KnowledgeOS

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages