Merge pull request #8 from beeb/option-filename

v0.2.5

Author: beeb

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "awsbck"
-version = "0.2.4"
+version = "0.2.5"
 edition = "2021"
 authors = ["Valentin Bersier <[email protected]>"]
 license = "MIT OR Apache-2.0"

Cargo.toml

@@ -19,6 +19,7 @@ Arguments:
 
 Options:
   -i, --interval <SECONDS>  Specify an interval in seconds to run the backup periodically [env: AWSBCK_INTERVAL=]
+  -f, --filename <NAME>     The name of the archive that will be uploaded to S3, without extension (optional) [env: AWSBCK_FILENAME=]
   -r, --region <REGION>     The AWS S3 region [env: AWS_REGION=]
   -b, --bucket <BUCKET>     The AWS S3 bucket name [env: AWS_BUCKET=]
       --id <KEY_ID>         The AWS S3 access key ID [env: AWS_ACCESS_KEY_ID=]
@@ -40,6 +41,16 @@ $ awsbck -i 3600 -b my_bucket /my_folder
 
 ## Installation
 
+### Prebuilt binaries
+
+Check out [the releases](https://github.com/beeb/awsbck-rs/releases) for prebuilt binaries.
+
+### Cargo
+
 ```shell
 $ cargo install awsbck
 ```
+
+### Docker
+
+Coming soon

README.md

@@ -24,14 +24,23 @@ pub async fn upload_file(archive_path: PathBuf, _temp_dir: TempDir, params: &Par
         .load()
         .await;
     let client = Client::new(&shared_config);
-    let filename = format!(
-        "awsbck_{}.tar.gz",
-        params
-            .folder
-            .file_name()
-            .map(|f| f.to_string_lossy().to_string())
-            .unwrap_or("backup".to_string())
-    );
+    let filename = params
+        .filename
+        .clone()
+        .map(|f| match f {
+            f if !f.ends_with(".tar.gz") => format!("{f}.tar.gz"),
+            f => f,
+        })
+        .unwrap_or_else(|| {
+            format!(
+                "awsbck_{}.tar.gz",
+                params
+                    .folder
+                    .file_name()
+                    .map(|f| f.to_string_lossy().to_string())
+                    .unwrap_or("backup".to_string())
+            )
+        });
     let multipart_upload_res: CreateMultipartUploadOutput = client
         .create_multipart_upload()
         .bucket(&params.aws_bucket)

src/aws.rs

@@ -21,6 +21,10 @@ struct Cli {
     #[arg(short, long, value_name = "SECONDS", env = "AWSBCK_INTERVAL")]
     interval: Option<u64>,
 
+    /// The name of the archive that will be uploaded to S3, without extension (optional)
+    #[arg(short, long, value_name = "NAME", env = "AWSBCK_FILENAME")]
+    filename: Option<String>,
+
     /// The AWS S3 region
     #[arg(
         short = 'r',
@@ -59,6 +63,8 @@ pub struct Params {
     pub folder: PathBuf,
     /// An optional interval duration in seconds
     pub interval: Option<u64>,
+    /// The name of the archive that will be uploaded to S3 (without extension)
+    pub filename: Option<String>,
     /// The AWS S3 region
     pub aws_region: RegionProviderChain,
     /// The AWS S3 bucket name
@@ -100,6 +106,7 @@ pub async fn parse_config() -> Result<Params> {
     Ok(Params {
         folder,
         interval: params.interval,
+        filename: params.filename,
         aws_region,
         aws_bucket,
         aws_key_id,