> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scanoss.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Verify Installation

> Verify that all SCANOSS components are functioning correctly after installation.

The [`test.sh`](https://github.com/scanoss/on-premise/blob/main/install/test.sh) script verifies that the SCANOSS Engine, Knowledge Base, and API are all functioning correctly after installation.

> Before running this script, ensure the `resources/` directory has read
> permissions. If not, run: `chmod -R +r /resources`

## Running the Script

```bash theme={null}
./test.sh
```

Once executed, you will be presented with the following menu:

```bash theme={null}
Starting verification script for SCANOSS...

Select options from the menu to verify different aspects of your environment
----------------------------------------------------------------------------
1) Verify scanning feature
2) Check API service status
3) Check API service metrics
4) Quit
```

**Verify scanning feature** - generates a `scan_results.json` file. This file should include a match for the test file located in the `/resources` directory.

**Check API service status** - the API returns:

```json theme={null}
{ "alive": true }
```

**Check API service metrics** - the API returns a JSON response containing request counts, performed scans, and related metrics.

If all three checks return the expected output, your on-premise SCANOSS installation is complete and ready to use.
