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

# Installation

> Install CatOps Hub on your server

## Quick Install

Run this command on your server:

```bash theme={null}
curl -fsSL https://get.catops.app/hub.sh | sudo sh
```

<Info>
  Requires root access. The script will use `sudo` automatically.
</Info>

## What Happens

The script will:

1. Download the latest CatOps Hub
2. Create `catops` system user
3. Install to `/opt/catops/`
4. Add user to docker group (for container monitoring)
5. Set up systemd service
6. Start the dashboard on port 8090

## Installation Options

### Custom Port

```bash theme={null}
curl -fsSL https://get.catops.app/hub.sh | sudo sh -s -- -p 9000
```

### Enable Auto-updates

```bash theme={null}
curl -fsSL https://get.catops.app/hub.sh | sudo sh -s -- --auto-update
```

Creates a systemd timer that checks for updates daily.

### All Options

| Option          | Description                    |
| --------------- | ------------------------------ |
| `-p <port>`     | Custom port (default: 8090)    |
| `--auto-update` | Enable automatic daily updates |
| `-u`            | Uninstall CatOps Hub           |
| `-h, --help`    | Show help                      |

## After Installation

You'll see:

```
CatOps Hub installed successfully!

Dashboard: http://YOUR_IP:8090
Data dir:  /opt/catops/data

Next steps:
  1. Open http://YOUR_IP:8090 in your browser
  2. Create your admin account
  3. Activate your license at /activate
```

## Updating

To update CatOps Hub to the latest version:

```bash theme={null}
curl -fsSL https://get.catops.app/update-hub.sh | sh
```

Or if you installed with `--auto-update`, updates happen daily automatically.

## Managing the Service

<CodeGroup>
  ```bash Check Status theme={null}
  sudo systemctl status catops-hub
  ```

  ```bash Restart theme={null}
  sudo systemctl restart catops-hub
  ```

  ```bash View Logs theme={null}
  sudo journalctl -u catops-hub -f
  ```

  ```bash Stop theme={null}
  sudo systemctl stop catops-hub
  ```
</CodeGroup>

## Open Firewall Port

Make sure port 8090 is accessible:

<CodeGroup>
  ```bash UFW (Ubuntu) theme={null}
  sudo ufw allow 8090
  ```

  ```bash firewalld (CentOS/RHEL) theme={null}
  sudo firewall-cmd --add-port=8090/tcp --permanent
  sudo firewall-cmd --reload
  ```
</CodeGroup>

## Supported Systems

| OS      | Architecture         |
| ------- | -------------------- |
| Linux   | x86\_64, ARM64, ARM  |
| macOS   | Intel, Apple Silicon |
| FreeBSD | x86\_64              |

## Troubleshooting

<AccordionGroup>
  <Accordion title="Service fails to start">
    Check logs:

    ```bash theme={null}
    sudo journalctl -u catops-hub -n 50
    ```

    Common issues:

    * Port already in use - use `-p` to change port
    * Permission denied - reinstall the script
  </Accordion>

  <Accordion title="Docker containers not showing">
    The install script adds catops user to docker group automatically. If containers still don't show:

    ```bash theme={null}
    sudo usermod -aG docker catops
    sudo systemctl restart catops-hub
    ```
  </Accordion>

  <Accordion title="Cannot access dashboard">
    * Check firewall settings
    * Verify service is running: `systemctl status catops-hub`
    * Try locally: `curl http://localhost:8090`
  </Accordion>
</AccordionGroup>