User guide
Rynhult is spoken RIN-hult.
How to use Rynhult day to day. Each page covers one job; the pages run in the order a new owner needs them: install, first project and session, your phone, backups, more machines, then everyday work and advanced setup. New to the words? See the Glossary. Invited by an owner? Start at Getting started.
v1.0: the self-hosted Linux server, browser access including the phone web app, and existing Linux/macOS/Windows-WSL nodes. Native apps are later, serial post-v1 work; the experimental source described in the advanced pages is not a v1 native release. See platform scope and native-app order.
Install and first steps
| Page | What it covers |
|---|---|
| Install | Linux main, Linux/macOS/Windows-WSL nodes, v1 scope and certificate trust |
| Deploying | Draft small-team deployment: Linux server, private remote access, nodes, recovery and updates |
| Install on Windows | Rynhult Setup for Windows 11: the main Rynhult or an additional machine |
| Install on a Mac | Rynhult Setup for macOS: an additional machine |
| Getting started | First sign-in, the Get started list, the layout, your first session |
| Glossary | The words Rynhult uses, in plain language |
| Host and providers | Signing your agents in (Providers), machine health and plan usage |
| Connect an agent | Installing and signing in an agent CLI where Rynhult can't install it: step by step per system |
| Projects | New projects (empty, cloned or on GitHub), trust, and registering folders |
| Project brief | Reusable project scope, private captioned references and versioned team intake |
| New session | Starting a session: the task, the agent, and everything under Advanced |
| Sessions | Watching, typing into, stopping and resuming sessions |
| Overview | The home screen: what needs you and what is running |
| Inbox | Everything that needs your attention |
Your phone
| Page | What it covers |
|---|---|
| Connect your phone | Reaching Rynhult from a phone, its certificate, the app and notifications |
| Notifications and app | Push notifications and installing Rynhult on your phone |
Backups and more machines (owners)
| Page | What it covers |
|---|---|
| Backups | Encrypted Linux/S3/local targets, opt-in hourly captures, retention maintenance and restore drills |
| Nodes | Using other machines: adding, updating and removing them |
Everyday work
| Page | What it covers |
|---|---|
| Workspaces | Research without a project, and promoting it to one |
| Files | Browsing and editing a project's, workspace's or session's files |
| Wikis | Reading a project's wiki |
| Preview | Seeing a project's running web app inside Rynhult |
| Search | Finding anything said in any session's conversation |
| Keys | API keys for projects, given to sessions as environment variables |
| Budgets | Optional limits on your own plan usage |
| Guardrails | What agents are stopped from doing, in every permission mode |
| Schedules | Start sessions at times you choose |
| Orchestrate a project | A team of agents plans and builds with you: the whole process, step by step <!-- lane F --> |
| Orchestrator | Optionally granting a bounded team of helpers and watching or stopping it |
| Orchestration playbook | How to run a team well: one working list, written briefs, independent review, gates and owner decisions |
| Publishing | Putting a project on a hostname |
| Catalog | Profiles, skills, agents and MCP servers |
| Keyboard shortcuts | Moving fast |
| Every feature at a glance | A screenshot tour of everything Rynhult does |
| Troubleshooting | Symptoms, likely causes, checks and safe fixes, drawn from operational problems |
| FAQ | Short answers |
Running Rynhult (owners)
| Page | What it covers |
|---|---|
| Settings | Your preferences and owner installation controls |
| Admin features | Owner controls for optional features and Previews |
| People and sign-in | Your sign-ins and password; inviting people (owners) |
| Updating Rynhult | Back up and update the main Rynhult; sync other machines |
| Status board | One full-screen view of every machine, project and running session, for a large display |
| Audit | Who changed what |
| Usage and bug reports | Optional sharing, report review, local history and deletion |
Advanced (owners)
| Page | What it covers |
|---|---|
| Remote access | Disabled public access and one-use LAN device pairing, renewal and revocation |
| Company sign-in with Microsoft Entra ID | Member OIDC pilot, off by default and not yet tenant-qualified |
| Groups | Opt-in authority, private Git exchange, published Files/Wiki and group sessions |
| High availability | Standby status and owner-run manual failover with PostgreSQL |
| DNS providers | Scoped credentials, vault Publishing and trial zones |
| Qualify a DNS provider | Owner-run disposable-zone checks, least-privilege credentials and qualification reports |
| Caddy hardening | Certificate credentials, root helper, sandbox, timeouts and log policy |
| Mobile devices | Post-v1 experimental native enrollment, owner controls and qualification limits |
| Desktop apps | Post-v1 developer source and qualification; not the v1 browser app |
| Rename readiness | Read-only rename planning; how it differs from implemented phase B aliases |
Command names and compatibility
Use rynhult for CLI help, rynhultd for the daemon, rynhult-node for additional
machines, and rynhult-guard for the tool guard. rynhult daemon, rynhult node
and rynhult guard dispatch to the same components. The legacy commands acc,
accd, acc-node and acc-guard remain supported aliases.
All other existing acc* helper commands remain supported compatibility aliases,
including acc-install, acc-request, acc-hook, acc-statusline,
acc-wiki-check, acc-restore and acc-db-transfer. Existing automation can keep
using them. Both RYNHULT_* and ACC_* settings work; when both are set, the
RYNHULT_* value wins, even when empty. Phase B adds command and Linux/WSL
service aliases without moving data or starting duplicate services. The Python
package acc, existing /srv/acc paths, database names and browser cookies stay
unchanged. Mac launchd labels and Windows tasks are not renamed. Existing
installations need no data migration or reinstall; see
name compatibility and alias-only deployment
before adding aliases from a reviewed checkout.
The public site is rynhult.dev, documentation is rynhult.dev/docs/ (docs.rynhult.dev redirects there), and contact details are in the repository README and security policy. The telemetry collector at telemetry.rynhult.dev runs as a pre-release staging service; telemetry remains opt-in.
This page is generated from docs/wiki/User-Guide.md; the same page is under Guide inside Rynhult.