AppFeed/templates/JacobBoloonisRepository/s3sync.xml
2021-04-18 14:02:46 -04:00

74 lines
3.9 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<Container version="2">
<Name>s3sync</Name>
<Repository>whatname/docker-s3sync</Repository>
<Registry>https://hub.docker.com/repository/docker/whatname/docker-s3sync</Registry>
<Network>bridge</Network>
<Shell>sh</Shell>
<Privileged>false</Privileged>
<Support>https://forums.unraid.net/topic/106320-support-what-name-s3sync/</Support>
<Project>https://github.com/what-name/docker-s3sync</Project>
<Overview>This application backs up every folder mounted at `/data/` to a given AWS S3 path using the `aws s3 sync` command. It requires a pair of (IAM) Access and Secret Keys.&#13;
&#13;
You can supply the usual s3 sync parameters such as `--delete` and everything else. The cron schedule defines how often the sync command is executed, and it uses a lockfile to avoid parallel executions.</Overview>
<WebUI></WebUI>
<TemplateURL>https://raw.githubusercontent.com/what-name/unraid-templates/main/s3sync.xml</TemplateURL>
<Icon>https://raw.githubusercontent.com/what-name/unraid-templates/main/static/s3-icon.png</Icon>
<PostArgs></PostArgs>
<Networking>
<Mode>bridge</Mode>
<Publish></Publish>
</Networking>
<Data>
<Volume>
<HostDir>/mnt/user/example</HostDir>
<ContainerDir>/data/example</ContainerDir>
<Mode>ro</Mode>
</Volume>
</Data>
<Environment>
<Variable>
<Value>your_access_key_here</Value>
<Name>ACCESS_KEY</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>your_secret_key_here</Value>
<Name>SECRET_KEY</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>bucket_region_here</Value>
<Name>REGION</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value></Value>
<Name>S3SYNCPARAMS</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>0 * * * *</Value>
<Name>CRON_SCHEDULE</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>s3://spirit-cloud-backup</Value>
<Name>S3PATH</Name>
<Mode></Mode>
</Variable>
</Environment>
<Config Name="ACCESS_KEY" Target="ACCESS_KEY" Default="" Mode="" Description="Your AWS Access Key." Type="Variable" Display="always" Required="true" Mask="false">your_access_key_here</Config>
<Config Name="SECRET_KEY" Target="SECRET_KEY" Default="" Mode="" Description="Your AWS Secret Key." Type="Variable" Display="always" Required="true" Mask="false">your_secret_key_here</Config>
<Config Name="Region" Target="REGION" Default="" Mode="" Description="The region of your bucket." Type="Variable" Display="always" Required="true" Mask="false">bucket_region_here</Config>
<Config Name="S3 Sync Parameters" Target="S3SYNCPARAMS" Default="" Mode="" Description="(Optional) Extra parameters for the s3 sync command." Type="Variable" Display="always" Required="false" Mask="false"></Config>
<Config Name="S3 Path" Target="S3PATH" Default="" Mode="" Description="The target bucket path with optional prefix." Type="Variable" Display="always" Required="true" Mask="false">s3://your_bucket_name</Config>
<Config Name="Cron Schedule" Target="CRON_SCHEDULE" Default="" Mode="" Description="Cron schedule of backup." Type="Variable" Display="always" Required="true" Mask="false">0 * * * *</Config>
<Config Name="Backup Source Example" Target="/data/example" Default="" Mode="ro" Description="This folder will be backed up." Type="Path" Display="always" Required="false" Mask="false">/mnt/user/example</Config>
<Beta>true</Beta>
<Description>This application backs up every folder mounted at `/data/` to a given AWS S3 path using the `aws s3 sync` command. It requires a pair of (IAM) Access and Secret Keys.&#13;
&#13;
You can supply the usual s3 sync parameters such as `--delete` and everything else. The cron schedule defines how often the sync command is executed, and it uses a lockfile to avoid parallel executions.</Description>
<templatePath>/tmp/GitHub/AppFeed/templates/JacobBoloonisRepository/s3sync.xml</templatePath>
</Container>