Document installing, upgrading and backing up Strawly 1.0 #5

Merged

GrumpyStraw merged 8 commits from feature/versioning-deployment into main

2026-10-04 17:29:02 +02:00

GrumpyStraw commented

2026-10-04 17:26:10 +02:00

Owner

Changes

Documentation for the 1.0 release.

Installing: new pages for trying Strawly on your own computer (--local), deploying on a server, deploying on TrueNAS, running multiple instances, and a manual install without the strawly CLI.
Upgrading and versions: how core and module versions relate, how strawly upgrade and strawly rollback work, and how to choose or change the instance port with strawly set-port. strawly uninstall is documented too.
Backup and restore: the in-app encrypted backup and restore, and the strawly backup command.
Modules: modules register themselves with the backend on start and every minute after that. The module pages, introduction and install guides are brought up to date with this.
Demo data: what the demo data set contains.
TrueNAS generator: the Azure worker now starts from dist/src/worker.js.

## Changes Documentation for the 1.0 release. - **Installing:** new pages for trying Strawly on your own computer (`--local`), deploying on a server, deploying on TrueNAS, running multiple instances, and a manual install without the `strawly` CLI. - **Upgrading and versions:** how core and module versions relate, how `strawly upgrade` and `strawly rollback` work, and how to choose or change the instance port with `strawly set-port`. `strawly uninstall` is documented too. - **Backup and restore:** the in-app encrypted backup and restore, and the `strawly backup` command. - **Modules:** modules register themselves with the backend on start and every minute after that. The module pages, introduction and install guides are brought up to date with this. - **Demo data:** what the demo data set contains. - **TrueNAS generator:** the Azure worker now starts from `dist/src/worker.js`.

GrumpyStraw added 8 commits

2026-10-04 17:26:10 +02:00

Document in-app database backup and restore 9dd3ff74da

Document installing, upgrading and versioning Strawly a3cfef8370

New guides for trying Strawly locally, deploying on a server with the installer, deploying on TrueNAS (with an in-browser config generator), multiple instances, and a manual install. Configuration, environment variables, updating, backup, troubleshooting and architecture now describe the strawly CLI, .env, modes, versioning and module self-registration instead of the removed YAML generator.

Run the Azure worker from dist/src/worker.js in the TrueNAS generator d9d1f15fc8

Describe what the demo data contains 6a83a068d7

Document strawly uninstall 29a309fab0

Modules re-register every minute a0bed219c7

Document choosing and changing the instance port 4cc749d4cc

Bring the module pages, introduction and install guides up to date 582ad8bd19

Module pages and the introduction still described the removed strawly-deployment.yml generator and seed-modules script. They now cover strawly enable-module and disable-module, self-registration, resource types starting disabled, the default UTC schedules and versions. The Azure page now says recommendations run only for enabled resource types. The install guides mention the port question and turning on resource types after adding credentials.

GrumpyStraw self-assigned this

2026-10-04 17:28:24 +02:00

GrumpyStraw added the

Kind/Docs

label

2026-10-04 17:28:28 +02:00

GrumpyStraw merged commit 2bdb39363a into main

2026-10-04 17:29:02 +02:00

GrumpyStraw deleted branch feature/versioning-deployment

2026-10-04 17:29:02 +02:00

GrumpyStraw referenced this pull request from a commit

2026-10-04 17:29:03 +02:00