Proxy Configuration

​

What is a Proxy?

​

Why Use a Proxy with SCANOSS?

​

Centralised API Key Management

​

Security & Access Control

• Enforce corporate policies with centralised traffic monitoring and filtering
• Restrict access to authorised internal systems
• Maintain full visibility into all API interactions

​

Usage Tracking & Logging

• Monitor scan activity by team or project
• Analyse API usage patterns
• Preserve detailed audit logs for compliance

​

Network Architecture Requirements

• Centralised outbound traffic control
• Internal certificate-based communication
• Deep packet inspection and filtering

​

Prerequisites

• Caddy: A reverse proxy server used to inject your SCANOSS API key into outgoing API requests.
• SCANOSS API key: Required to authenticate requests to the SCANOSS API.

​

Basic Proxy Configuration

1. Create a new folder to store Caddy and its configuration.
2. Inside that folder, create a new file named Caddyfile.
3. Add the following configuration:

:1980 {
    reverse_proxy https://api.scanoss.com {
        header_up x-api-key "YOUR_API_KEY_HERE"
        header_up Host api.scanoss.com
    }
}

4. Replace YOUR_API_KEY_HERE with your actual SCANOSS API key. If you do not yet have a key, refer to the Prerequisites section above.
5. Save and close the file.

You can change port 1980 to any available port (e.g. 8080 or 8888).
Ensure the chosen port is not already in use by another service.

​

Running Caddy

​

Interactive Mode

caddy run --config Caddyfile

sudo caddy run --config Caddyfile

​

Background Mode

caddy start --config Caddyfile

sudo caddy start --config Caddyfile

​

Stopping Caddy

caddy stop

​

Running as a systemd Service (Linux only)

Note: systemd is a Linux-specific init system and is not available on macOS by default. macOS users should use launchd or run Caddy in background mode instead.

1. Create a systemd service file:

sudo nano /etc/systemd/system/caddy-proxy.service

2. Add the following configuration:

[Unit]
Description=Caddy API Proxy
After=network.target

[Service]
ExecStart=/usr/bin/caddy run --config /etc/caddy/Caddyfile
Restart=always
User=caddy
Group=caddy

[Install]
WantedBy=multi-user.target

Update /etc/caddy/Caddyfile to match the actual path to your Caddyfile.
Update /usr/bin/caddy if Caddy is installed in a different location (verify with which caddy).

3. Enable and start the service:

sudo systemctl daemon-reload
sudo systemctl enable caddy-proxy
sudo systemctl start caddy-proxy

4. Check the service status:

sudo systemctl status caddy-proxy

​

Running as a Windows Service

1. Download and install NSSM (Non-Sucking Service Manager).
2. Open PowerShell as Administrator and change directory to the folder where NSSM is installed.
3. Install Caddy as a service:

nssm install CaddyProxy "C:\path\to\caddy.exe" "run --config C:\path\to\Caddyfile"

Replace C:\path\to\caddy.exe with the actual path to your Caddy executable.
Replace C:\path\to\Caddyfile with the actual path to your Caddyfile.

4. Configure the service (optional):

nssm set CaddyProxy AppDirectory "C:\path\to\caddy\folder"
nssm set CaddyProxy AppStdout "C:\path\to\logs\caddy-output.log"
nssm set CaddyProxy AppStderr "C:\path\to\logs\caddy-error.log"

5. Start the service:

nssm start CaddyProxy

6. Verify the service is running:

nssm status CaddyProxy

nssm stop CaddyProxy
nssm restart CaddyProxy
nssm remove CaddyProxy confirm

​

Troubleshooting

​

Port Conflicts

{
  admin off
}

​

Stopping Existing Caddy Instances

taskkill /IM caddy.exe /F

pkill caddy

# Or, if running as a systemd service (Linux only)
sudo systemctl stop caddy