ObsidianVault Documentation
Learn how to set up and use ObsidianVault to automatically backup your Minecraft server worlds and plugins.
Download ObsidianVault Plugin
Get the latest version of ObsidianVault from your preferred plugin hosting platform. All versions are identical and updated simultaneously.
System Requirements
• Minecraft 1.8 or higher
• Bukkit, Spigot, Paper, or Purpur
• Java 8 or higher
• 512MB available RAM minimum
• Outbound HTTPS connections
• Stable internet connection
• Firewall access to *.obsidianvault.io
• Port 443 (HTTPS) access
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
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.
- 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
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
/reload confirm
or restart your server.Configuration Options
client-id
Your ObsidianVault client ID
client-secret
Your ObsidianVault client secret
cron
Cron expression for automatic backups
worlds
List of world names to include in backups
Command Reference
All commands start with /backup
/backup list
Lists all available backups for worlds and plugins
/backup create world <world-name>
/backup create plugin <plugin-name>
Creates a new backup of the specified world or plugin
/backup history <world|plugin> <name>
Shows all backup versions for a specific world or plugin
/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
)
/backup delete <world|plugin> <name> [date]
Deletes a specific backup or all backups for a world/plugin
/backup status
Shows the status of all active backup operations
Permission Nodes
obsidianvault.backup
Access to all backup commandsobsidianvault.admin
Administrative commands (delete, restore)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 midnight0 */6 * * *
Every 6 hours0 0 * * 0
Weekly on Sunday at midnight0 0 1 * *
Monthly on the 1st at midnight*/30 * * * *
Every 30 minutesCron 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)
Common Issues & Solutions
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
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
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
If you need further assistance: