Skip to main content

Configure App Integration

Apex Home supports integration with many popular applications, allowing you to view and interact with them directly from your dashboard.

Supported Applications​

Apex Home supports integration with many applications including:

  • Proxmox
  • Portainer
  • GitHub
  • Grafana
  • Home Assistant
  • Synology
  • And many more...

Setting Up App Integration​

To integrate an application with Apex Home:

  1. Navigate to "Settings" > "App Integrations" from the dashboard.

    App Integration

  2. Click on "All Integrations" in the top-right corner to see available integrations.

  3. Select the application you want to integrate from the list.

  4. Fill in the required configuration details:

    • Integration Name: A name to identify this integration (especially useful if you have multiple instances of the same app)
    • API/Connection Details: Specific information needed to connect to the application (varies by app)
    • Authentication Credentials: API keys, tokens, or login credentials as required

  5. Click "Save" to create the integration.

  6. The integrated application will now appear in your App Integrations list.

  7. You can access the app's features directly from your dashboard.

App-Specific Configuration​

Each application requires specific configuration details. Common examples include:

GitHub Integration​

  • Username
  • Personal Access Token
  • Repository information (optional)

Proxmox Integration​

  • Server URL
  • API Token
  • Node name

Home Assistant​

  • Server URL
  • Long-lived access token
  • Connection type
Pro Tip

Managing Multiple Instances of the Same App​

Apex Home allows you to configure multiple instances of the same app. For example, if you have more than one GitHub account, you can integrate both accounts by configuring separate instances of the GitHub app. Just ensure that each instance has a distinguishable Integration Name so you can easily identify them.

Using Integrated Apps​

Once configured, integrated apps can be accessed in several ways:

  1. Live View: Some applications offer a live preview directly within Apex Home.
  2. Quick Actions: Perform common tasks without leaving your dashboard.
  3. Link Integration: Create dashboard links that open specific features of your integrated apps.

Important Notes​

  • Due to security reasons, once an app is integrated, it cannot be modified or edited directly. If you need to change any configuration details for a particular app, you must remove the current integration and configure it again with the updated details.
  • App integrations are user-specific and not shared between Apex Home users.
  • API keys and tokens are encrypted before being stored in the database.