Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

create vaultwarden-backup template #468

Closed
Binary file added templates/img/vaultwarden-backup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions templates/vaultwarden-backup.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?xml version="1.0"?>
<Container version="2">
<Name>vaultwarden-backup</Name>
<Icon>https://raw.githubusercontent.com/selfhosters/unRAID-CA-templates/master/templates/img/vaultwarden-backup.png</Icon>
<Repository>ghcr.io/ttionya/vaultwarden-backup</Repository>
<Registry>https://github.com/ttionya/vaultwarden-backup/pkgs/container/vaultwarden-backup</Registry>
<Network>bridge</Network>
<Shell>sh</Shell>
<Privileged>false</Privileged>
<Support>https://github.com/Homelabbers/unraid-templates/issues/new/choose</Support>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not us.

<Project>https://github.com/ttionya/vaultwarden-backup</Project>
<Requires>Vaultwarden</Requires>
<Overview>Backup vaultwarden (formerly known as bitwarden_rs) &#xD;
You will need to setup rclone using this guide: https://github.com/ttionya/vaultwarden-backup?tab=readme-ov-file#configure-rclone-%EF%B8%8F-must-read-%EF%B8%8F &#xD;
</Overview>
<Config Name="Vaultwarden/Bitwarden data location" Target="/bitwarden/data/" Default="" Mode="rw" Description="Where Vaultwarden/Bitwarden data is stored" Type="Path" Display="always" Required="true" Mask="false"></Config>
<Config Name="rclone config location" Target="/config/" Default="/mnt/user/appdata/vaultwarden-backup/rclone" Mode="rw" Description="Location of rclone config" Type="Path" Display="always" Required="true" Mask="false">/mnt/user/appdata/vaultwarden-backup/rclone</Config>
<Config Name="rclone remote name" Target="RCLONE_REMOTE_NAME" Default="BitwardenBackup" Mode="" Description="Name of rclone remote to use for backups" Type="Variable" Display="always" Required="true" Mask="false">BitwardenBackup</Config>
<Config Name="Rclone Remote Directory" Target="RCLONE_REMOTE_DIR" Default="/BitwardenBackup/" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">/BitwardenBackup/</Config>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<Config Name="Rclone Remote Directory" Target="RCLONE_REMOTE_DIR" Default="/BitwardenBackup/" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">/BitwardenBackup/</Config>
<Config Name="rclone remote directory" Target="RCLONE_REMOTE_DIR" Default="/BitwardenBackup/" Mode="" Description="Directory in remote to store backups in" Type="Variable" Display="always" Required="true" Mask="false">/BitwardenBackup/</Config>

<Config Name="Rclone Global Flag" Target="RCLONE_GLOBAL_FLAG" Default="" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<Config Name="Rclone Global Flag" Target="RCLONE_GLOBAL_FLAG" Default="" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
<Config Name="rclone global flags" Target="RCLONE_GLOBAL_FLAG" Default="" Mode="" Description="Additional flags for rclone. See https://github.com/ttionya/vaultwarden-backup?tab=readme-ov-file#rclone_global_flag" Type="Variable" Display="advanced" Required="false" Mask="false"></Config>

<Config Name="CRON" Target="CRON" Default="5 * * * *" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">5 * * * *</Config>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<Config Name="CRON" Target="CRON" Default="5 * * * *" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">5 * * * *</Config>
<Config Name="Cron schedule" Target="CRON" Default="5 * * * *" Mode="" Description="Cron schedule for backup frequency. Default: Every 5 minutes." Type="Variable" Display="always" Required="true" Mask="false">5 * * * *</Config>

<Config Name="Enable Zip" Target="ZIP_ENABLE" Default="TRUE" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">TRUE</Config>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<Config Name="Enable Zip" Target="ZIP_ENABLE" Default="TRUE" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">TRUE</Config>
<Config Name="Compress files" Target="ZIP_ENABLE" Default="TRUE" Mode="" Description="Whether to compress backups" Type="Variable" Display="advanced" Required="false" Mask="false">TRUE</Config>

<Config Name="Zip Password" Target="ZIP_PASSWORD" Default="WHEREISMYPASSWORD" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">WHEREISMYPASSWORD</Config>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<Config Name="Zip Password" Target="ZIP_PASSWORD" Default="WHEREISMYPASSWORD" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">WHEREISMYPASSWORD</Config>
<Config Name="Compression password" Target="ZIP_PASSWORD" Default="WHEREISMYPASSWORD" Mode="" Description="Password for compressed files. Will always be used if compression is enabled." Type="Variable" Display="advanced" Required="false" Mask="false">WHEREISMYPASSWORD</Config>

<Config Name="Zip Type" Target="ZIP_TYPE" Default="zip" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">zip</Config>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<Config Name="Zip Type" Target="ZIP_TYPE" Default="zip" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">zip</Config>
<Config Name="Compression type" Target="ZIP_TYPE" Default="zip" Mode="" Description="Use 'zip' or '7z' for compression" Type="Variable" Display="advanced" Required="false" Mask="false">zip</Config>

<Config Name="Backup File Suffix" Target="BACKUP_FILE_SUFFIX" Default="%Y%m%d" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">%Y%m%d</Config>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<Config Name="Backup File Suffix" Target="BACKUP_FILE_SUFFIX" Default="%Y%m%d" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">%Y%m%d</Config>
<Config Name="Backup file suffix" Target="BACKUP_FILE_SUFFIX" Default="%Y%m%d" Mode="" Description="Suffix for all backup files, such as a date stamp." Type="Variable" Display="advanced" Required="false" Mask="false">%Y%m%d</Config>

<Config Name="Days to Keep Backup" Target="BACKUP_KEEP_DAYS" Default="0" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">0</Config>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<Config Name="Days to Keep Backup" Target="BACKUP_KEEP_DAYS" Default="0" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">0</Config>
<Config Name="Days to keep backup" Target="BACKUP_KEEP_DAYS" Default="0" Mode="" Description="How many days to keep backups. Use 0 to keep all backups." Type="Variable" Display="advanced" Required="false" Mask="false">0</Config>

<Config Name="URL to Ping" Target="PING_URL" Default="" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<Config Name="URL to Ping" Target="PING_URL" Default="" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
<Config Name="Healthcheck URL" Target="PING_URL" Default="" Mode="" Description="A URL to ping when backup is completed, to confirm process has completed." Type="Variable" Display="advanced" Required="false" Mask="false"></Config>

<Config Name="Enable email" Target="MAIL_SMTP_ENABLE" Default="FALSE" Mode="" Description="Enable email notifications" Type="Variable" Display="advanced" Required="false" Mask="false">FALSE</Config>
<Config Name="SMTP settings" Target="MAIL_SMTP_VARIABLES" Default="" Mode="" Description="Details for email SMTP. See https://github.com/ttionya/vaultwarden-backup?tab=readme-ov-file#mail_smtp_variables" Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
<Config Name="Email recipient" Target="MAIL_TO" Default="" Mode="" Description="Email address to send emails to." Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
<Config Name="Send email after backup" Target="MAIL_WHEN_SUCCESS" Default="FALSE" Mode="" Description="Whether to send emails after a successful backup" Type="Variable" Display="advanced" Required="false" Mask="false">FALSE</Config>
<Config Name="Send email after failure" Target="MAIL_WHEN_FAILURE" Default="FALSE" Mode="" Description="Whether to send emails after a failed backup" Type="Variable" Display="advanced" Required="false" Mask="false">FALSE</Config>
<Config Name="Timezone" Target="TIMEZONE" Default="UTC" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">UTC</Config>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<Config Name="Timezone" Target="TIMEZONE" Default="UTC" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">UTC</Config>
<Config Name="Timezone" Target="TIMEZONE" Default="UTC" Mode="" Description="Timezone for date stamps." Type="Variable" Display="advanced" Required="false" Mask="false">UTC</Config>

</Container>