Getting started with CockpitMod

What you will learn

This lesson covers the complete first-time setup of your CockpitMod account: accessing the dashboard, entering your Dirs21 API credentials, activating your first module and verifying that the connection is working correctly.

Before you begin

You will need: an active CockpitMod subscription (purchase any module from the shop if you have not already done so); access to your email to retrieve the account access link; and your Dirs21 API key and property identifier from your Dirs21 account settings. If you need help finding these, see the Dirs21 Account Access Guide.

Step 1: Access your CockpitMod account

Navigate to cockpitmod.org/login and enter the email address you used when purchasing your module. Click Send Access Link. Check your email inbox (and spam folder if not found within 2 minutes) for the access email from noreply@cockpitmod.org. Click the link in the email to open your dashboard. The link is valid for 30 minutes; request a new one if it expires.

Step 2: Enter your Dirs21 API credentials

On first login, the dashboard will display a setup wizard. Enter your Dirs21 API key in the API Key field and your Dirs21 property identifier in the Property ID field. Click Validate Connection. The system tests the connection immediately. A green confirmation message indicates success. If you receive an error, revisit the API setup guide.

Step 3: Configure your first module

With the API connection validated, navigate to your active modules list. Click the module you have purchased to open its configuration page. Each module has a guided setup checklist. Complete each item in sequence — the checklist is designed to take you through all required settings in the correct order. You cannot accidentally activate a module with incomplete configuration.

Step 4: Verify activation

After completing the setup checklist, click Activate Module. The module will perform a test sync with your Dirs21 account and confirm that it has successfully connected to the relevant data. The module card on your dashboard will show "Active" status. You will receive a confirmation email summarising the module settings. Your first usage report will be available in the dashboard 24 hours after activation.