Skip to content
refiroo

Run the service

These journeys are for operators keeping refiroo available and understanding what the deployment actually runs. Operators need the appropriate server or platform access for installation work; the application’s Operations permission opens deployment diagnostics. It does not grant reference data editing or security administration.

Run the service, and recover from an expected refusal

Section titled “Run the service, and recover from an expected refusal”

An operator begins with Install with Compose, The database and Configure refiroo to prepare persistent storage, PostgreSQL and the instance’s settings. Start the service, then use Health and startup checks to decide whether it is ready for traffic. Liveness means that the process answers; readiness also needs the database and at least one workspace it can serve. Readiness alone does not prove every workspace is available.

If startup refuses or enters maintenance mode, read the stated cause, resulting service state and recovery action. Troubleshooting connects database connectivity, collation, missing extensions, migration revisions and model problems to their safe remedies. Correct the named setting or dependency, then restart where instructed and check readiness again. Do not edit migration revision rows or stored model documents to suppress a refusal. Upgrades covers migration and unsupported stored-release recovery.

Once serving, use Monitoring to inspect workspace and process readiness, background threads, connection pools and request diagnostics. During a database outage, a process can remain live while unready. Restore connectivity and allow workers to recover; repeatedly restarting healthy processes does not restore PostgreSQL. With several processes, follow Several processes for their shared database and file storage.

Complete the recovery preparation with Back up and restore. Restore a backup into a separate database and run the documented restore check there, then inspect the recorded rehearsal outcome. The check must not target the live database. A failed rehearsal is evidence to resolve before depending on that backup, rather than proof of a working restore. Preserve the concise error and correlation references when escalating a failure.

Check what a deployment runs and how it is configured

Section titled “Check what a deployment runs and how it is configured”

An operator identifies the running application version, supported model languages, model release and source information before diagnosing a mismatch or planning maintenance. Monitoring connects the deployment pages with process and workspace information. Configure refiroo explains the settings catalogue, current values, defaults, and whether a value came from the environment.

The pages inspect configuration; they do not edit environment settings. Change those in the server or platform configuration and restart as documented. Secret settings show whether they are present rather than revealing their values; the database address masks its password. After a model activation, check the selected workspace’s running release rather than assuming all workspaces run the same one.

Use Licence and source to verify the running version’s source link, especially for a modified installation. If behaviour still disagrees with configuration, return to Troubleshooting with the version, time, failing action, workspace and diagnostic reference, excluding credentials and full environment files.

Start with What you run and Install with Compose, then choose automatic public certificates, your organisation’s certificate files or an existing HTTPS balancer in Serve over HTTPS. Automatic issuance and renewal needs a public DNS name and reachable port 443; port 80 is optional for redirects. Preserve certificate storage and check renewal through the public address. Private names need a different certificate route.

Set up sign-in and mail, test a complete sign-in and recovery path, then complete the production checklist and security checklist. A healthy container does not establish that every workspace, public sign-in, notification or receiver works. Keep the outcomes for your installation and correct failed checks before admitting traffic.

Follow Upgrades to record the running source, supported model languages, private configuration, backup and file archive before maintenance. Check the new deployment’s readiness, workspaces, sign-in and retained files before reopening writes. An unsupported stored model needs the documented raising review; a database migration refusal needs its stated remedy.

Model releases and rollback distinguishes a compatible model activation from application rollback. Restoring an older application requires its matching pre-upgrade database and configuration; changing the bootstrap model file does not switch existing workspaces. Do not repair a cutover by editing migration revision rows.

Back up, rehearse and move to another host

Section titled “Back up, rehearse and move to another host”

Back up and restore connects a consistent PostgreSQL and job-file backup to its source version and protected keys. Rehearse the restore in an isolated database and inspect the recorded result before relying on it. Include the public sign-in path and file downloads when testing a replacement host; a database-only check does not establish those.

Use the same runbook’s host-move sequence to stop writers, take the final consistent copy, restore, verify and cut over the public address. Preserve the recovery material until the replacement is proven. Retire the old host after cutover so it cannot resume competing work. A missing sealing key prevents recovering stored secrets from their encrypted values alone.

Secrets and keys identifies client credentials, signing material, cursor keys and the sealing key before choosing the replacement procedure. Check which processes share them and coordinate with the administrator and receivers. Retain the key matching a backup; replacing a value blindly can make stored credentials unreadable or invalidate saved positions.

The database covers connection budgets and growth. Combine it with Background jobs, Webhook delivery and Monitoring to watch files, queues, delivery results and retained logs. Change retention deliberately; it can remove diagnostic detail without removing reference data. Several processes requires shared identity and file storage. Measure the actual workload before making capacity or recovery-time promises.

Enable optional AI or prepare a developer instance

Section titled “Enable optional AI or prepare a developer instance”

Read AI operation before Set up AI. Choose the provider, built-in assistant and external-agent connection separately, set a send policy and credentials, apply the configuration, then verify each enabled path. Inspect calls and task retention as well as service readiness. Disabling a feature stops future use; it does not erase published records, history or all retained task material. Follow the same page for replacement credentials or cleanup.

For local source work instead, follow Developer instance. It has a different support boundary from the reference installation. Use Command-line tools for the documented maintenance commands, and Troubleshooting to prepare concise diagnostics when a recovery fails.