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

# n8n Setup

> Install and configure the Chariow node on your self-hosted n8n instance

This guide walks you through installing the Chariow community node on a self-hosted n8n instance and connecting it to your store.

## Prerequisites

Before you begin, make sure you have:

* A **self-hosted n8n instance** (v1.0 or later)
* A **Chariow API key** (starts with `sk_`) — generate one from **Settings** → **API Keys** in your [Chariow Dashboard](https://app.chariow.com)
* **Node.js >= 18.10** on the machine running n8n

***

## Installation

<Warning>
  The Chariow node is not yet available through the n8n Community Nodes UI. You must install it manually using one of the methods below.
</Warning>

### npm (recommended)

Run the following command in your n8n user directory:

```bash theme={null}
cd ~/.n8n && npm install @chariow/n8n-nodes-chariow
```

Then restart n8n for the node to appear.

### Docker

If you run n8n in Docker, set the `N8N_CUSTOM_EXTENSIONS` environment variable to install the package on startup:

```yaml theme={null}
# docker-compose.yml
services:
  n8n:
    image: n8nio/n8n
    environment:
      - N8N_CUSTOM_EXTENSIONS=@chariow/n8n-nodes-chariow
    # ... your other config
```

Restart the container after updating the configuration.

<Info>
  Community Nodes UI support is planned. Once available, you will be able to install directly from **Settings** → **Community Nodes** inside n8n.
</Info>

***

## Configure credentials

<Steps>
  <Step title="Open credentials">
    In n8n, go to **Settings** → **Credentials** → **Add Credential**.
  </Step>

  <Step title="Search for Chariow">
    Search for **Chariow API** and select it.
  </Step>

  <Step title="Enter your API key">
    Paste your Chariow API key (starts with `sk_`) into the **API Key** field.
  </Step>

  <Step title="Save">
    Click **Save**. n8n will test the connection automatically. A green tick confirms your key is valid.
  </Step>
</Steps>

***

## Verify installation

<Steps>
  <Step title="Create a new workflow">
    Click **New Workflow** in n8n.
  </Step>

  <Step title="Add a node">
    Click **+** to add a node and search for **Chariow**.
  </Step>

  <Step title="Confirm both nodes appear">
    You should see two nodes:

    * **Chariow** — for performing actions (get, list, create)
    * **Chariow Trigger** — for starting workflows from store events
  </Step>
</Steps>

***

## Troubleshooting

<AccordionGroup>
  <Accordion title="Nodes not appearing after install">
    * Make sure you installed the package in the correct directory (`~/.n8n` for npm installs)
    * Restart n8n completely after installation
    * Check the n8n logs for any installation errors: `docker logs n8n` or check your process output
    * Verify the package is installed: `ls ~/.n8n/node_modules/@chariow`
  </Accordion>

  <Accordion title="Credential test failed">
    * Confirm your API key starts with `sk_` and is copied in full
    * Check that your store is active in the Chariow dashboard
    * Ensure your n8n instance can reach `https://api.chariow.com` (no firewall or proxy blocking)
  </Accordion>

  <Accordion title="Docker container issues">
    * Verify the `N8N_CUSTOM_EXTENSIONS` environment variable is set correctly
    * Rebuild and restart the container: `docker compose down && docker compose up -d`
    * Check container logs for npm install errors: `docker logs <container_name>`
  </Accordion>
</AccordionGroup>

***

## Next steps

<CardGroup cols={2}>
  <Card title="Available resources" icon="database" href="/en/n8n/overview#chariow-node-resources">
    See all resources and operations
  </Card>

  <Card title="Trigger events" icon="bolt" href="/en/n8n/overview#trigger-events">
    Browse the 8 available trigger events
  </Card>
</CardGroup>