Yavaren™ user guideVersion 1.0.0Printable guide · PDF

Administration

Install Yavaren on your own servers, by clicks

Plan an on-prem installation in Your setup, run one command on your server, and a browser installer finishes every step. Air-gapped networks and upgrades work the same way.

Yavaren can run in your own environment (the on-prem edition). You do not need to edit a file to install it: you choose everything here, run one command on your server, and a browser installer on that server does the rest.

You are on an on-prem installation already. To upgrade it, an admin of your organisation opens the installation in the Yavaren portal and chooses Upgrade; the same browser installer does the upgrade on your server.

Before you start

1. Choose

Open Your setup › Install on your servers › Plan an installation and answer seven short steps: where it runs (one machine with Docker, or Kubernetes; air-gapped or not), the database (bundled or yours), where documents are kept, single sign-on and the HTTPS certificate, the runners and their size, and how Yavaren support may help (sessions you approve, or full remote management if your contract offers it). The last step shows your choices in plain words, the sizing they need and anything to fix.

The portal never asks for a password, a key or a token. You type those into the installer on your own server.

2. Run one command

You get one command. Copy it and run it on your server (or, for Kubernetes, on the computer with kubectl and helm). It works once, for two hours; New command makes another. It checks everything it downloads against checksums and Yavaren's signature before anything runs, then prints an address with a one-time code in it.

3. Click through

Open the address. The installer checks the machine, makes every secret (none is shown), sets up HTTPS, checks the database, the document storage and single sign-on, starts Yavaren, prepares the database, creates your first admin, connects to Yavaren, starts the runners and runs the readiness checks. Each step can be retried; if anything stops, run the same command again and it carries on. Download diagnostics gives Yavaren support what they need, with secrets removed.

The progress shows here too, step by step, under the installation.

Air-gapped networks

Choose Air-gapped. Instead of a command with a code you get three downloads (the offline bundle, the signed manifest and the offline licence file) and one command to run from the bundle inside your network. The same browser installer opens. Nothing is sent anywhere.

Upgrades

When a newer release is out, the installation shows Upgrade to …. You get a new one-time command (or files, air-gapped); the installer backs up the bundled database, switches the version, prepares the database and runs the checks. Your settings and secrets are kept.