Skip to main content

Setup Automated Backup

This guide explains how to set up automated backups for the Apex Home Application Dashboard using N8n. The backups are uploaded to Google Drive, and a notification is sent back to Apex Home.

Prerequisites​

  1. Ensure you have N8n installed and running Documentation.
  2. Set up Google Drive credentials in N8n.
  3. Obtain an API key for Apex Home Documentation.

Steps​

1. Create a New Workflow​

  1. Open N8n and create a new workflow.
  2. Add the following nodes to the workflow:

a. Schedule Trigger Node​

  • Select the Schedule Trigger node from the list of available nodes.
  • Configure the desired interval for the backup schedule.

Schedule Trigger

b. Backup Apex Home Data Node​

  • Select the Apex Home node from the list of available nodes. Select Backup Apex Home Data from Actions.
  • Configure the following parameters:
    • Credential to connect with
    • Resource: Settings
    • Operation: Backup
    • Backup Password: Enter your own password
  • Use your Apex Home API key for credentials.

Backup Node

c. Upload File to Google Drive Node​

  • Select the Google Drive node from the list of available nodes.
  • Configure the following parameters:
    • Credential to connect with
    • File Name: backup-{{ $now.format('yyyy-MM-dd-HH-mm-ss') }}.apex or anything else that suits you.
    • Parent Drive: 'Select your parent drive here'
    • Parent Folder: Select your parent folder here
  • Use your Google Drive OAuth2 credentials.

Backup Node

d. Send Notification to Apex Home Node​

  • Select the Apex Home node from the list of available nodes.
  • Configure the following parameters:
    • App Name: Apex Backup
    • Title: Daily Backup Created
    • Text: Daily backup created and uploaded to Google Drive
    • HTML: Daily backup created and uploaded to Google Drive. Click the button below to check
    • Tags: Apex Home, Personal, Drive, Backup, Automation
    • Button Text: Check Now
    • Button Link: ={{ $json.webViewLink }}
  • Use your Apex Home API key for credentials.

Notification Node

2. Connect the Nodes​

  • Connect the Schedule Trigger node to the Backup Apex Home Data node.
  • Connect the Backup Apex Home Data node to the Upload File to Google Drive node.
  • Connect the Upload File to Google Drive node to the Send Notification to Apex Home node.

At this p;oint your workflow should look like this:

Backup Workflow

3. Activate the Workflow​

  • Once all nodes are configured and connected, activate the workflow.

Follow these steps to ensure your backups are automated and secure.