> For the complete documentation index, see [llms.txt](https://docs.xygeni.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xygeni.io/xygeni-products/xygeni-shield/installing.md).

# Installing Shield

Xygeni Shield is distributed as a signed package for each platform. Ask your Xygeni contact or your IT team for the package that matches your machine.

{% hint style="warning" %}
**Shield does nothing until it is activated.** After installing, set your Xygeni token as described in [Activating Shield](https://docs.xygeni.io/xygeni-products/xygeni-shield/activating.md). Until then the agent blocks nothing, scans nothing and sends nothing, whatever its policy says.
{% endhint %}

### Debian / Ubuntu

Install the `.deb` package with `apt` (use the arm64 package on ARM machines):

```bash
sudo apt install ./xygeni-fw_<version>_amd64.deb
```

The package:

* installs the `xygeni-fw` service and starts it, also at every boot,
* installs the Shield certificate in the system trust store, so your tools accept the connections Shield inspects,
* installs the **tray app**, which starts automatically when you log in,
* adds your user to the `xygeni-fw` group, so the tray app and the `xygeni-fw` command can talk to the agent.

**Log out and log back in** after installing, so the new group membership takes effect.

### Windows

Run the Xygeni Shield installer (`.exe`) and accept the elevation prompt. The installer:

* installs Shield under `C:\ProgramData\Xygeni\Shield\`,
* installs the Shield certificate in the Windows trust store,
* registers and starts the **XygeniShield** Windows service, which starts automatically at boot,
* installs the tray app, and adds the `xygeni-fw` command to the `PATH` of new terminals.

For unattended deployment (MDM, software distribution tools), run the installer silently and set the token in the same script:

```powershell
.\<installer>.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART
& "C:\ProgramData\Xygeni\Shield\bin\xygeni-fw.exe" config token <token>
```

{% hint style="info" %}
On Windows, commands that this guide shows with `sudo` are run without it from an **elevated** terminal: right-click *Terminal* or *Windows PowerShell* and choose **Run as administrator**.
{% endhint %}

### Checking the installation

Run `xygeni-fw status`:

```
$ xygeni-fw status
Xygeni Shield v1.0.6
Service:  active (enabled)
Policy:   0 allow / 3 deny  (+0 allow patterns, +1 deny patterns)
Account:  enrolled (plan team) - configuration managed by Xygeni Cloud
License:  active (Shield seat held, lease until 2026-10-29 18:40 UTC)
Cache:    12 entries (12 allowed, 0 blocked)
Config:   /etc/xygeni-fw/firewall.yaml
Logs:     journalctl -u xygeni-fw  |  /var/log/xygeni-fw/agent.log
```

* `Service: active` means the agent is running.
* `Account:` and `License:` tell you whether Shield is protecting the machine. Right after installing, `Account:` says `NOT ENROLLED`: set your token as described in [Activating Shield](https://docs.xygeni.io/xygeni-products/xygeni-shield/activating.md).

Once Shield is active, you can check a package without downloading it:

```bash
xygeni-fw test npm lodash 4.17.21
```

### Upgrading

Install the new package (or run the new Windows installer) over the existing one. There is no need to uninstall first: the token, the configuration and the local policy are kept.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.xygeni.io/xygeni-products/xygeni-shield/installing.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
