Getting Started

ObsidianVault Documentation

Learn how to set up and use ObsidianVault to automatically backup your Minecraft server worlds and plugins.

Quick Start

ObsidianVault requires a free account to get started. Sign up at obsidianvault.io/auth and get your credentials from your dashboard before configuring the plugin.

1. Download Plugin

Download the latest ObsidianVault plugin from Spigot or our website

2. Get Credentials

Create an account and generate your Credentials from your dashboard

3. Configure & Backup

Add your Credentials to config.yml and start backing up your worlds

Download

Download ObsidianVault Plugin

Get the latest version of ObsidianVault from your preferred plugin hosting platform. All versions are identical and updated simultaneously.

SpigotMC

The original and most popular Minecraft plugin repository

SpigotMC

Paper Hangar

Modern plugin repository with enhanced features and security

Paper Hangar

Modrinth

Fast, modern platform for Minecraft mods and plugins

Modrinth

Latest Version

All platforms host the same version of ObsidianVault. Choose the platform you're most comfortable with or that your server management tools integrate with best.

System Requirements

Server Requirements

• Minecraft 1.8 or higher

• Bukkit, Spigot, Paper, or Purpur

• Java 8 or higher

• 512MB available RAM minimum

Network Requirements

• Outbound HTTPS connections

• Stable internet connection

• Firewall access to *.obsidianvault.io

• Port 443 (HTTPS) access

Installation

Installing ObsidianVault

Download the latest ObsidianVault.jar from SpigotMC
Place the JAR file in your server's plugins folder
Restart your server or reload plugins
The plugin will generate a config file at plugins/ObsidianVault/config.yml

Compatibility

ObsidianVault supports Minecraft 1.8+ and is compatible with Spigot, Paper, Purpur, and other Bukkit-based servers.

Get Your Credentials

Getting Your Credentials

Before you can configure the plugin, you need to obtain your Credentials from your ObsidianVault dashboard. This is a one-time setup process.

Create an Account
Visit obsidianvault.io/auth and create a free account (5GB storage included)
Access Your Dashboard
After signing up, log in to your dashboard
Generate Credentials
Click on "Credentials" in your dashboard and click "Generate New Credentials"
Copy Your Credentials
You'll receive a Client ID and Client Secret. Copy these values - you'll need them for the next step. You can also regenerate them at any time.
Make sure to copy both your Client ID and Client Secret immediately - they won't be shown again!
Save for Configuration
Keep these credentials handy - you'll add them to your config.yml in the next section.

Security Best Practices

Never share your credentials publicly
Don't commit config.yml with credentials to version control
Use environment variables for production servers if possible
Regenerate your credentials immediately if they're compromised

Configuration

Configuring ObsidianVault

Now that you have your credentials, let's configure the plugin. The main configuration file is located at plugins/ObsidianVault/config.yml

Basic Configuration

# ObsidianVault Configuration

# Authentication settings for ObsidianVault
auth:
  client-id: your-client-id-here      # Get this from your dashboard
  client-secret: your-client-secret-here  # Get this from your dashboard

# Backup configuration
backup:
  # Cron expression for scheduling backups (default: daily at midnight)
  # Format: minute hour day-of-month month day-of-week
  cron: "0 0 * * *"

  # List of worlds to include in the automated backups
  worlds:
    - world
    - world_nether
    - world_the_end

Apply Configuration

After adding your credentials, reload the plugin with /reload confirm or restart your server.

Configuration Options

Authentication

client-id

Your ObsidianVault client ID

client-secret

Your ObsidianVault client secret

Backup Settings

cron

Cron expression for automatic backups

worlds

List of world names to include in backups

Commands

Command Reference

All commands start with /backup

List Backups

/backup list

Lists all available backups for worlds and plugins

Create Backup

/backup create world <world-name>

/backup create plugin <plugin-name>

Creates a new backup of the specified world or plugin

World backups include all chunks, player data, and world settings. Plugin backups include the plugin's data folder.

View History

/backup history <world|plugin> <name>

Shows all backup versions for a specific world or plugin

Download Backup

/backup download <world|plugin> <name> [date]

Generates a download link for the specified backup

Date format: ISO-8601 (e.g., 2024-01-15T10:30:00Z)

Delete Backup

/backup delete <world|plugin> <name> [date]

Deletes a specific backup or all backups for a world/plugin

This action is irreversible. You will be asked to confirm before deletion.

Check Status

/backup status

Shows the status of all active backup operations

Permission Nodes

obsidianvault.backupAccess to all backup commands

obsidianvault.adminAdministrative commands (delete, restore)

Scheduling

Automatic Scheduled Backups

ObsidianVault uses cron expressions to schedule automatic backups. Configure the schedule in your config.yml file.

Common Cron Patterns

0 0 * * *Daily at midnight

0 */6 * * *Every 6 hours

0 0 * * 0Weekly on Sunday at midnight

0 0 1 * *Monthly on the 1st at midnight

*/30 * * * *Every 30 minutes

Cron Format

Cron expressions consist of 5 fields:

minute hour day-of-month month day-of-week

• minute: 0-59

• hour: 0-23

• day-of-month: 1-31

• month: 1-12

• day-of-week: 0-7 (0 and 7 are Sunday)

Testing Your Schedule

Use online cron expression testers to verify your schedule before applying it. The plugin will log when scheduled backups run.

Troubleshooting

Common Issues & Solutions

Authentication Failed

If you see authentication errors in the console:

Verify your client-id and client-secret are correct
Ensure there are no extra spaces in the config
Check that your ObsidianVault account is active
Regenerate your credentials if needed

Backup Uploads Failing

If backups fail to upload:

Check your server's internet connection
Ensure you have enough storage quota
Verify firewall settings allow HTTPS connections
Check for disk space on your server

Large World Backup Issues

For worlds larger than 1GB:

Enable copy-before-upload: true
Increase server memory allocation
Schedule backups during off-peak hours
Consider backing up worlds separately

Getting Help

If you need further assistance:

Email Support