B
ObsidianVault
Dashboard

Plugin Integration

Learn how to integrate ObsidianVault with popular Minecraft plugins

ObsidianVault is designed to work seamlessly with many popular Minecraft plugins. This guide will walk you through the process of configuring various plugins to work with ObsidianVault's backup system.

Contents
Jump to a specific plugin integration

Server Backup Integration

Performance Optimized
Download

Server Backup is a high-performance backup solution that runs asynchronously to prevent server lag.

1

Install Server Backup Plugin

Download the Server Backup plugin from SpigotMC and place it in your server's plugins directory.

2

Configure FTP Settings

Edit the Server Backup configuration to enable FTP integration:

# In plugins/ServerBackup/config.yml
Ftp:
  # Enable FTP backup feature
  UploadBackup: true

  # FTP Server Configuration
  Server: "your-obsidianvault-ftp-server"
  Port: 21
  User: "your-ftp-username"
  Password: "your-ftp-password"

  # Backup Management
  DeleteLocalBackup: false  # Set to true to only store on FTP
  SSL: true  # Enable SSL encryption for secure transfers

  # FTP Path Configuration
  Path: "/backups"  # Remote directory for backups
  CreateDirectory: true  # Create directory if it doesn't exist
3

Configure Dynamic Backups

Enable dynamic backups to save disk space by only backing up modified chunks:

# In plugins/ServerBackup/config.yml
DynamicBackup:
  Enabled: true
  # Only backs up chunks that have been modified
  # Significantly reduces backup size while maintaining data integrity

Backup:
  # General backup settings
  Interval: 24  # Hours between automatic backups
  MaxBackups: 7  # Maximum number of backups to keep
  ExcludeFiles:
    - "cache"
    - "logs"
    - "tmp"
4

Restart Your Server

Restart your server to apply the configuration changes.

5

Test the Integration

Test the FTP integration using /backup ftp list to view files on the FTP server.

Backuper Integration

Popular
Download

Backuper is a simple yet powerful backup plugin for Paper/Folia servers that supports FTP/SFTP/Google Drive storage. Here's how to integrate it with ObsidianVault's FTP storage.

1

Install Backuper Plugin

Download the Backuper plugin from Modrinth and place it in your server's plugins directory.

2

Configure FTP Settings

Edit the Backuper configuration to connect to ObsidianVault's FTP storage:

# In plugins/Backuper/config.yml
ftp:
    enabled: true
  auto-backup: true  # Enable if you want automatic backups to FTP
  backups-folder: "backups"  # FTP directory for backups
  max-backups-number: 10  # Maximum number of backups to keep
  max-backups-weight: 0  # Maximum total size in MB (0 for unlimited)

  # FTP Authentication
  address: "your-obsidianvault-ftp-server"
  port: 21
  username: "your-ftp-username"
  password: "your-ftp-password"

  # Optional settings
  path-separator-symbol: "/"  # FTP path separator
  passive-mode: true  # Use passive mode for FTP
3

Configure Backup Settings

Configure the general backup settings:

# In plugins/Backuper/config.yml
backup:
  auto-backup: true
  backup-file-name-format: "yyyy-MM-dd_HH-mm-ss"
  add-directory-to-backup:
    - "plugins"
    - "config"
  exclude-directory-from-backup: []
  backup-period: 1440  # Minutes between backups (24 hours)
  backup-time: -1  # Set to hour (0-23) for fixed daily backup time
  delete-broken-backups: true
  skip-duplicate-backup: true
  after-backup: "NOTHING"  # Options: NOTHING, STOP, RESTART
  set-worlds-read-only: true
4

Restart Your Server

Restart your server to apply the configuration changes.

5

Test the Integration

Run a test backup using /backuper backup ftp to verify the FTP connection works.

AutoBackup Integration

Latest
Download

AutoBackup is a modern backup solution for Paper/Purpur servers that offers scheduled backups with FTP support and data compression. The plugin requires Java 21 or higher and is compatible with Minecraft 1.21.x.

Installation Steps

  1. Download the AutoBackup plugin from Modrinth
  2. Place the .jar file in your server's plugins directory
  3. Restart your server to generate the configuration files
  4. Configure the plugin in the generated config.yml file

FTP Configuration Example

# FTP Backup Configuration
ftp:
    enabled: true
  host: "ftp.example.com"
  port: 990  # Implicit TLS Port
  username: "your_username"
  password: "your_password"
  remote-path: "/backups"
  use-implicit-tls: true

# Backup settings
backup-frequency: 10800  # 3 hours in seconds
max-backups: 15
backup-path: "backups"
worlds:
  - world
  - world_nether
  - world_the_end

DriveBackupV2 Integration

Multi-Platform
Download

DriveBackupV2 is a versatile backup plugin that supports multiple storage platforms including FTP/SFTP. Here's how to integrate it with ObsidianVault's FTP storage.

1

Install DriveBackupV2

Download DriveBackupV2 from Modrinth and place it in your server's plugins directory.

2

Configure FTP Settings

Edit the DriveBackupV2 configuration to connect to ObsidianVault's FTP storage:

# In plugins/DriveBackupV2/config.yml
backup-storage-methods:
  - type: "ftpServer"
    hostname: "your-obsidianvault-ftp-server"
  port: 21
  username: "your-ftp-username"
  password: "your-ftp-password"
    base-dir: "backups"
    format: "backup-%date%.zip"

backup-settings:
  schedule: "0 */6 * * *"  # Every 6 hours
  keep-count: 10  # Number of backups to keep
  zip-compression: true

backup-list:
  - path: "world"
  - path: "world_nether"
  - path: "world_the_end"
  - path: "plugins/MyPlugin/data"
    blacklist:
      - "cache/**"
      - "temp/**"
3

Configure External Sources (Optional)

If you need to backup external databases or remote files:

# In plugins/DriveBackupV2/config.yml
external-backup-list:
  # Example remote FTP backup
  - hostname: "files.example.com"
    port: 21
    username: "ftpuser"
    password: "ftppass"
    format: "files-backup-%date%.zip"
    type: "ftpServer"
    base-dir: "/"
    backup-list:
      - path: "important-files"
        blacklist:
          - "*.tmp"
4

Restart Your Server

Restart your server to apply the configuration changes.

5

Test the Integration

Run a test backup using /drivebackup backup to verify everything works.

Have suggestions for improving this documentation? Let us know.