> 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/requirements.md).

# System requirements

### Operating systems

| Platform        | Supported versions                                           | Package          |
| --------------- | ------------------------------------------------------------ | ---------------- |
| Debian / Ubuntu | x86\_64 and arm64, Linux kernel 6.x or newer                 | `.deb`           |
| Windows         | Windows 10 / 11 x64 and the matching Windows Server releases | `.exe` installer |

On Debian / Ubuntu, Shield also needs `systemd` and `nftables` or `iptables`, which are present by default.

### Permissions

* **Debian / Ubuntu**: `sudo` access, to install the package.
* **Windows**: an Administrator account, to run the installer.

Once installed, everyday use does not need administrator rights.

### Network access

The machine must be able to reach:

* **Xygeni Cloud**, `api.xygeni.io` (HTTPS), for activation, the central policy and alerts.
* **The Xygeni malicious packages database**, `apipmd.xygeni.io` (HTTPS), to keep the local copy up to date.
* The public registries your tools use. Shield inspects the downloads from these hosts:

| Ecosystem                     | Hosts                                                                   |
| ----------------------------- | ----------------------------------------------------------------------- |
| npm / yarn / pnpm             | `registry.npmjs.org`                                                    |
| PyPI / pip / poetry / uv      | `pypi.org`, `files.pythonhosted.org`                                    |
| Maven / Gradle                | `repo1.maven.org`, `repo.maven.apache.org`                              |
| NuGet / .NET                  | `api.nuget.org`                                                         |
| RubyGems / Bundler            | `rubygems.org`                                                          |
| Cargo / Rust                  | `crates.io`, `static.crates.io`                                         |
| Go modules                    | `proxy.golang.org`                                                      |
| Composer / Packagist          | `repo.packagist.org`, `packagist.org`                                   |
| GitHub Actions                | `codeload.github.com`                                                   |
| VS Code / Open VSX extensions | `marketplace.visualstudio.com`, `*.gallery.vsassets.io`, `open-vsx.org` |
| Visual Studio extensions      | Same hosts as VS Code                                                   |
| JetBrains plugins             | `plugins.jetbrains.com`, `downloads.marketplace.jetbrains.com`          |
| Eclipse Marketplace           | `marketplace.eclipse.org`                                               |

Any other traffic, including normal web browsing and `github.com` itself (browsing, `git`, the API), is not inspected.

{% hint style="info" %}
For Composer, Shield sees the package metadata but not the download itself, which comes from GitHub. Rules that block a whole Composer package work; rules for specific versions do not.
{% endhint %}

{% hint style="info" %}
For an on-premises Xygeni installation, Shield can be pointed at your own servers instead of `api.xygeni.io` and `apipmd.xygeni.io`. See [Agent settings](https://docs.xygeni.io/xygeni-products/xygeni-shield/agent-settings.md#on-premises-xygeni).
{% endhint %}


---

# 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/requirements.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.
