User configurable backup filename

[jamesgeddes]

The problem

The backup service currently provides the user with the option to configure a name.

Counterintuitively, this does not set the filename. Even when the name is set, the backup file is seemingly given a random string as a filename, such as,

• 969fad88.tar
• a1467f82.tar
• 70344a3d.tar

According to community members, it is not currently possible to set the file name. This limitation poses several challenges for users who rely on backup management systems or external services for storage and versioning.

Use cases

• AWS S3 Integration: AWS S3, a commonly used cloud storage service, relies on consistent filenames for accurate versioning and retrieval of backup files. Enabling customizable filenames in Home Assistant would enhance compatibility with AWS S3 and similar services, ensuring seamless integration and reliable backup management.
• Backup System Compatibility: Various backup solutions, including rsync, BorgBackup, and Synology Hyper Backup, require filenames to adhere to specific formats for effective backup management and versioning. Allowing users to configure filenames in Home Assistant would facilitate seamless integration with these backup systems, enhancing overall backup efficiency and reliability.

Proposed Solution

Allow users to customize backup filenames according to their preferences. Add a filename attribute to the backup service configuration parameters, providing users with options to specify naming conventions, include timestamps, or incorporate unique identifiers.

What version of Home Assistant Core has the issue?

core-2024.2.5

What was the last working version of Home Assistant Core?

No response

What type of installation are you running?

Home Assistant OS

Integration causing the issue

Home Assistant Supervisor: Create a full backup.

Link to integration documentation on our website

No response

Diagnostics information

No response

Example YAML snippet

service: hassio.backup_full
metadata: {}
data:
  compressed: true
  location: nas
  name: habak

Anything in the logs that might be useful for us?

No response

Additional information

For context, my own daily backup process is as follows.

1. 0100: Output home assistant full backup to NAS
2. 0400: NAS backs up to AWS S3

With every backup getting a unique filename, it is not possible to use the AWS S3 built-in versioning capabilities. I will instead have to write a script that deletes the old backups from the NAS.

If I was able to set a consistent filename, new backups would overwrite the previous backup, which would ensure that

• my NAS does not fill up with old backup files.
• AWS S3 sees a new version of the same file.

I will gladly take this ticket if someone is able to,

• assign it to me.
• point me in the right direction!

---

First reported by Tankegroda on 2020-04-03 in forum thread Snapshot naming + Filename. Issue persists. I could not find a ticket here so apologies in advance if this is a duplicate.

[joostlek]

Please report this at the supervisor repository

[jamesgeddes]

@joostlek Are you not able to simply move this ticket to that repo?

[joostlek]

Nope, don't have the rights to

[jamesgeddes]

Ah fair enough. Would be good if more people were given the rights to do that as it would be more efficient 😄 Will re-log now. Thanks

[jamesgeddes]

Logged supervisor#4947

[joostlek]

And we usually don't like moving issues as different repositories have different issue templates, so although we can move them, they might miss information in other repositories. (For example if this was a frontend issue, it would miss the browser used and the OS you are running)

(Also FYI: The reason I sent you to there is because it looks like we do pass the name on to the supervisor doing the backup, so I assume its a bug in the supervisor)