Skip to main content

Initial setup

Connect the device that will run Link, then choose local execution or a cloud route with optional backups for Workspace or your software.

The current setup has three stages: Connect → Set up → Ready. Use the current Link package for your Control account. Earlier versions can show the previous model-first setup.

For the macOS desktop walkthrough, you need an Apple Silicon Mac, an available device slot and internet access. The package installs for your macOS user. Allow disk space and memory for the model and its engine. Terminal alternatives are under Connect your device.

Sign in to Control​

Use the same account and environment in Control and Aventail Link. The current production package opens control.aventail.co.uk. Production and development registrations are separate.

AVENTAIL / CONTROL

Sign in to the intended account

At a glance

Use your existing sign-in method

Open production Control or your organisation’s environment. Use the same account when Link opens its device approval page.

Process overview
  1. ControlOpen the intended environment.
  2. Sign inUse your existing Google, GitHub or email sign-in method.
  3. Connect a deviceInstall Link, then check the account and computer before approval.

Step 1 of 1: Use your existing sign-in method.

Process diagram for current Control sign-in.
AVENTAIL / CONTROL

Sign in to the intended account

At a glance

Use your existing sign-in method

Open production Control or your organisation’s environment. Use the same account when Link opens its device approval page.

Process overview
  1. ControlOpen the intended environment.
  2. Sign inUse your existing Google, GitHub or email sign-in method.
  3. Connect a deviceInstall Link, then check the account and computer before approval.

Step 1 of 1: Use your existing sign-in method.

Read the sign-in steps

Open Control. Choose Continue with Google, GitHub, or enter your email and password and select Sign In. Complete authentication to open the Dashboard.

On first sign-in, review the Terms & Conditions and accept if you agree. Then use Connect a device from the Dashboard.

Trouble signing in?​

  • Use the provider you originally used; another provider may open a different account.
  • For email/password access, select Forgot password? to start recovery.
  • If your organisation manages access, ask its administrator which sign-in method to use.

Start from Control​

In personal Control, choose Connect a device. The Desktop app tab offers macOS Apple Silicon, Windows x64 and Linux x64 packages. Finish setup in Link, then return to Control. Organisation screens can differ.

AVENTAIL / CONTROL

Connect a device

Full view

Connect a device

Choose Desktop app in Connect a device. Install Link on the computer you want to use, then finish setup there.

Slide 1 of 3: Connect a device.

Personal Control · captured 1 November 2026. Use the arrows or progress marks to move between slides.
AVENTAIL / CONTROL

Connect a device

Full view

Connect a device

Choose Desktop app in Connect a device. Install Link on the computer you want to use, then finish setup there.

Slide 1 of 3: Connect a device.

Pause and resume​

If the Dashboard shows Finish connecting your device, finish sign-in and approval in Link, then choose Refresh devices. Not now hides the progress card; it does not undo approval, revoke a key or stop an operation. After a reload, inspect your saved device list before repeating registration.

Earlier Control web setup wizard

Earlier web wizard​

The production Control walkthrough shows Register your first device, with Platform → Connect → Deploy. This is separate from Aventail Link's Connect → Models → Serving → Finish desktop setup; an organisation's development interface can differ.

AVENTAIL / CONTROL

Connect your first device

Full view

Control setup wizard

The setup wizard opens over the dashboard. Start with the Platform stage.

Slide 1 of 6: Control setup wizard.

Control setup screens captured 28 September 2026. Use the arrows or progress marks to move between slides.
AVENTAIL / CONTROL

Connect your first device

Full view

Control setup wizard

The setup wizard opens over the dashboard. Start with the Platform stage.

Slide 1 of 6: Control setup wizard.

Read the wizard steps

Open setup​

After first sign-in, the wizard opens over the Control Dashboard with macOS · Alpha · Apple Silicon selected. If it is minimised, use Finish setup at the bottom-right.

Choose a platform​

  • Apple Silicon Mac: select Continue for the desktop app. Older Control screens label the button Download Locai Link for macOS; those labels belong to the earlier walkthrough. Use the current installation steps below; the new setup follows Connect → Set up → Ready.
  • Terminal installation: expand Advanced: install via terminal and choose Linux / macOS (terminal) or Windows PowerShell. Follow headless registration.

Earlier pause and resume​

Select the × in the wizard header to minimise it, then Finish setup to reopen it. Before registration, the paused step also survives a page reload.

If a reloaded or second tab cannot resume deployment, check Notifications → Deployments before trying again. Once the model is Deployed, start serving; you do not need to download it again.

Connect your device​

Choose desktop sign-in or headless registration, then confirm the device is Online.

Download Link for macOS (Apple Silicon). This is the production release. For a development or staging account, use the download offered by that Control environment.

AVENTAIL / LINK

Connect, set up and get ready

Full view

Choose how this computer will run AI

The new setup has Connect, Set up and Ready. This capture follows browser approval.

Slide 1 of 5: Choose how this computer will run AI.

Link 2.4.0 · Apple Silicon · captured 13 November 2026. Use the arrows or progress marks to move between slides.
AVENTAIL / LINK

Connect, set up and get ready

Full view

Choose how this computer will run AI

The new setup has Connect, Set up and Ready. This capture follows browser approval.

Slide 1 of 5: Choose how this computer will run AI.

Read the installation and registration steps

Choose an installation path​

Open Connect a device from the personal Dashboard. Earlier and organisation interfaces may label this Register Device.

PathUse it forWhat connects the device
Desktop appA supported computer with a graphical desktopSign in from Link and approve it in your browser
Headless / CLIA supported Linux, macOS or Windows machine managed from a terminalInstall the service, then register with a one-time key

Desktop Mac​

  1. Download the current macOS Apple Silicon .pkg for your Control environment. The illustrated macOS walkthrough uses 2.4.0.
  2. Open it and select Continue → Install. Wait for The installation was successful, then select Close. The observed package installs for the current user without administrator authentication.
  3. In Aventail Link Setup → Connect, select Sign in with Aventail. Compare the browser approval code with Link and check the account and computer before approving.
  4. In 2.4.0’s Set up stage, choose Run a local model, Use a cloud model or Decide later. For cloud-first setup, Link opens the device’s routing page in Control. Choose a saved provider connection or connect a provider, allow this device to use it, and select a model.
  5. Add optional backups, review the order and select Apply routing. A local backup is last. Link downloads and prepares it without requiring ordinary serving to be enabled. Follow the complete routing and backups walkthrough.
  6. Wait for Link’s Ready screen and inspect the destination order. Choose Open Link or Use your model in an app. Confirm the device has reported online and send a harmless test request. Applied confirms the route; local backup readiness and a completed response need separate checks.

Earlier 2.3.x setup continues through Models → Serving → Finish. For that local-model path, choose and download a model, wait for Downloaded · Ready for the next step, enable serving if required, and finish setup.

AVENTAIL / LINK

Download and serve your first model

Full view

Download and serve your first model

After browser approval, Link continues through Models, Serving and Finish. This capture shows the model download has completed.

Slide 1 of 5: Download and serve your first model.

Aventail Link 2.3.2 on macOS · captured 2 November 2026. Model and memory values are examples. Use the arrows or progress marks to move between slides.
AVENTAIL / LINK

Download and serve your first model

Full view

Download and serve your first model

After browser approval, Link continues through Models, Serving and Finish. This capture shows the model download has completed.

Slide 1 of 5: Download and serve your first model.

The package installs under your user Library and launches Link for setup; start at login is established when setup finishes. A move from 1.x requires a new registration and model deployments; it does not migrate the old installation. See the illustrated installation walkthrough or macOS installation help.

Read the headless installation steps
AVENTAIL / CONTROL

Install Link from a terminal

Full view

Headless / CLI installation

In Connect a device, choose Headless / CLI and select the target terminal. Run the command on the computer you want to connect.

Slide 1 of 3: Headless / CLI installation.

Personal Control · Linux/macOS installer panel · 1 November 2026. Use the arrows or progress marks to move between slides.
AVENTAIL / CONTROL

Install Link from a terminal

Full view

Headless / CLI installation

In Connect a device, choose Headless / CLI and select the target terminal. Run the command on the computer you want to connect.

Slide 1 of 3: Headless / CLI installation.

Use Aventail Link 2.x for current terminal installations. It supports Linux x64 with systemd, macOS Apple Silicon and Windows x64 through PowerShell. Check platforms and release channels first.

  1. In the intended Control account, open Connect a device → Headless / CLI and use the Terminal selector to choose Linux / macOS or Windows PowerShell.
  2. Run the install command on that device. These examples download the production release:
curl -fsSL https://get.aventail.co.uk/install.sh | sh

The installer verifies the release checksum, installs for your user and starts the background service. Without a key, the service waits for registration. If the installer changes PATH, open a new terminal or use the executable path it prints. See file locations and Linux server startup.

  1. Back in Control, set Key valid for (hours) and select Create a setup key. A registration key is single-use; the default validity is 24 hours, with a supported range of 1–168 whole hours.
  2. Copy the whole current registration command from Control and run it on the target device. Production Link 2.3.x uses its Aventail management address by default; old LINK_API_BASE overrides are no longer read. Personal Control shows a separate registration command after the keyless install command:
aventail register --registration-key 'YOUR_REG_KEY'

This command works in both terminal options. As an alternative, supply the key through an environment variable:

AVENTAIL_REGISTRATION_KEY='YOUR_REG_KEY' aventail register

Replace YOUR_REG_KEY with the generated key. Keep it out of screenshots, source control and shared logs. The environment-variable alternatives keep keys out of process arguments; pasted commands can still remain in shell history. For another environment, use its current package and complete command; do not add an old LINK_* override. Keep the registration key private.

  1. Run aventail status, then confirm the device is Online in that same Control account. If the key expired or was already used, generate another and repeat registration; do not reinstall only to replace a key.

Unattended installation​

Personal Control shows installation and registration separately. A combined install-and-register command is available for unattended setup; organisation Fleet screens provide combined enrollment commands. Put the environment variables on the shell after the pipe:

curl -fsSL https://get.aventail.co.uk/install.sh | AVENTAIL_REGISTRATION_KEY='YOUR_REG_KEY' sh

For PowerShell, run the keyed installer in its own scope and remove the key even if installation fails:

$env:AVENTAIL_REGISTRATION_KEY = 'YOUR_REG_KEY'
try { & ([scriptblock]::Create((irm https://get.aventail.co.uk/install.ps1))) }
finally { Remove-Item Env:AVENTAIL_REGISTRATION_KEY }

Fleet enrollment uses AVENTAIL_FLEET_KEY instead. Copy the fleet command from Add devices; see fleet enrollment.

Locai Link (Legacy Aventail) 1.x registration screenshots
AVENTAIL / LEGACY LINK

Headless registration in Locai Link (Legacy Aventail) 1.3.2

Full view

Device registration in Control

Register Device opens a dialog over the dashboard. Choose the installation path for the target machine.

Slide 1 of 4: Device registration in Control.

Older headless registration capture; match commands to the package installed on the target device. Use the arrows or progress marks to move between slides.
AVENTAIL / LEGACY LINK

Headless registration in Locai Link (Legacy Aventail) 1.3.2

Full view

Device registration in Control

Register Device opens a dialog over the dashboard. Choose the installation path for the target machine.

Slide 1 of 4: Device registration in Control.

These earlier captures show the old locai command. Follow the current Aventail commands above for a new installation. get.locai.co.uk now serves Aventail releases too; it no longer selects a 1.x installer.

Verify the device is connected​

Open Devices, identify the new device and confirm Online. Match the name and computer details reported by Link. The headless CLI also supports --device-name; names alone do not prove that you selected the intended machine. A registration success message alone does not establish that the background service is online.

In personal Control, refresh the device list after approval. A device registered to another account will not complete this account’s setup. Check the account before repeating registration.

If the device stays Waiting for first report or shows Device is offline, check that Link is running, retain the exact error and follow Link troubleshooting.

Device limit reached​

If Control shows Device limit reached, review Plan & usage, or ask the account owner to make capacity available. Preserve existing devices you do not own.

Recognise a device-limit message

Remove a device​

To remove Link or release a device slot, see Remove a device.

Deploy a model​

Choose a compatible model and an Online device with room for both the model and its engine. Aventail setup can download and serve a model directly; do not deploy another copy if it is already installed.

AVENTAIL / CONTROL

Browse the Aventail Library

Full view

Browse the Aventail Library

Open Models in personal Control. Use search and Model ownership to find a model, then open its Details.

Slide 1 of 3: Browse the Aventail Library.

Personal Control · captured 1 November 2026. Use the arrows or progress marks to move between slides.
AVENTAIL / CONTROL

Browse the Aventail Library

Full view

Browse the Aventail Library

Open Models in personal Control. Use search and Model ownership to find a model, then open its Details.

Slide 1 of 3: Browse the Aventail Library.

Read the deployment steps

Choose a model​

For your first model, use Link's Models tab. Browse the catalogue, choose a compatible model and start its download. Alternatively, browse Models → Aventail Library in personal Control and open Details; Visit devices leads to device installations and actions.

Check the model's format, download size, required memory and intended tools. The captured Processing in registry labels and empty versions reflect a known Control display issue. Check download availability on the intended device rather than relying on that label alone.

If you selected a model during Link setup, check whether it is already installed before deploying it again. Custom uploads and image/audio classification require different compatibility checks and inputs from this language-model walkthrough.

Check progress​

Keep Link running. Watch its download progress and the reported outcome in Control’s Activity panel. An accepted command is not a completed download. Read the final result before retrying.

If deployment fails​

  • Check the target device is still Online and has free disk space.
  • Record the model name and exact error message before retrying.
  • Check progress before starting another deployment. An accepted upload format does not guarantee the device can run the model.

Serve a model​

Serving makes the installed model available to Workspace and API clients. Use Start serving for an installed model in Link. Keep Link running while you use it.

AVENTAIL / LINK

Manage local models and backups

Full view

Manage local models and backups

Models distinguishes the active cloud destination from a prepared local backup. Model details provides the Model ID; Serving settings provides context and memory controls.

Slide 1 of 6: Manage local models and backups.

Aventail Link 2.4.1 on macOS · captured 14 November 2026. Account/device identity obscured. Model names and memory values are examples. Use the arrows or progress marks to move between slides.
AVENTAIL / LINK

Manage local models and backups

Full view

Manage local models and backups

Models distinguishes the active cloud destination from a prepared local backup. Model details provides the Model ID; Serving settings provides context and memory controls.

Slide 1 of 6: Manage local models and backups.

Read the serving steps

Start serving​

  1. In Link, open Models and choose Start serving for an installed compatible model.
  2. Read its state. Ready to serve can precede loading into memory; the first request may load the model. Loaded and a completed response are stronger checks than an enabled configuration.
  3. Open the model's serving settings when you need to change context length, Keep loaded or Fit more context. Inspect the memory estimate and apply the intended change.
  4. Send a short request from Connect or the local API. If it fails, preserve the error and check Link's model state.

Personal Control groups device actions under Devices; an older organisation interface can have a separate Serving page. In either interface, wait for the reported command outcome and verify locally.

Choose the endpoint​

Client locationAPI base URL
Same machine as Linkhttp://127.0.0.1:8100/v1
Another authorised machineThe Link machine's reachable address and serving port, followed by /v1
Docker containerAn address reachable from inside the container; see Open WebUI

Replace 8100 with your actual port. 0.0.0.0 is a server bind address, not a client destination. A network address shown in Control does not establish that it is reachable or protected for remote use.

Stop serving​

Use Stop serving in Link, or the model’s serving control for the intended device in Control, and confirm the stopped state. Stopping interrupts requests using that model, but it stays installed for next time. To free disk space, see Removing models.

Next: chat in Workspace or connect your software.