Quickstart

Warning: This guide is mainly for testing purpose. For security reasons, we highly recommend to follow these guides for a production setup.

This quickstart guide has been designed with Flashback bucket that will connect with an AWS S3 and a S3 backend.

This quickstart tutorial assumes you already have an account with AWS. If not, we suggest you find the links via our prerequisites page.

Follow these steps to start quickly to store with Flashback:

1

Signin and login

You can use A Google or GitHub account or sign in and log in at platform.flashback.tech with an e-mail and a password.

To log in to the platform with an e-mail address and password, use an e-mail address with a domain name used in Google workspace, Microsoft 365 or equivalent.

2

Create your first bucket

Delegating your AWS access is recommended, but you can follow this guide for an intial setup:

• In the left-hand menu, select Storage → Buckets.

• Click the + Add Bucket button and select the provider where you will connect your tenant bucket or storage account to this Flashback bucket.

• On the “Create Bucket” form, enter the following fields (all are required unless noted otherwise):

  • Name: "My First Bucket"

  • Bucket: The exact identifier as defined by your provider in your tenant (e.g. the S3 bucket name in your AWS account).

  • Storage Type: S3

  • Access Key: Your S3 API Key ID

  • Secret Key: Your AWS secret key

  • Endpoint (optional): custom S3 endpoint URL

  • Region: AWS region required if no custom endpoint.

• Click Save (or Create) at the bottom of the form. Your bucket will now appear in the listof Buckets.

You have a more detailled guide for creating buckets.

3

Create your first repository

• In the left-hand menu, go to Storage → Repositories.

• Click the Add Repository (or “+ New Repository”) button.

• Fill in the Repository details

  • Name: A human-readable description (e.g. “MyApp-Backups”).

  • API type: Choose S3 to determine which protocol your backend server will use.

• Switch to the Storage Buckets tab in the form. Click Add Bucket and select "My First Bucket".

• Click Save (or Create). Your new repository will now appear in the list.

You have a more detailled guide for creating repositories.

4

Generate API keys

Once the repo is saved, open it and go to the API Keys tab. Click Add API key, then:

• Description: “Write-only key for ”Quickstart"

• Access mode: WRITE

Click Create and immediately copy the generated secret to your clipboard—secrets are only shown once.

For security reasons, the API secret is only available to copy in the clipboard right after the creation of the API key entry. See here for more information.

5

Upload your First File

Set up the S3 client with your Flashback endpoint and credentials:

# flashback_aws_config.py
import boto3
from botocore.client import Config

# Replace with your Flashback credentials and endpoint
ENDPOINT = "https://s3-us-east-1.aws.flashback.tech"
# Consider READ/WRITE API Information of the Repository
API_KEY_ID = "YOUR_API_KEY_ID" 
API_SECRET = "YOUR_API_SECRET"

session = boto3.session.Session(
    aws_access_key_id=API_KEY_ID,
    aws_secret_access_key=API_SECRET
)

s3_client = session.client(
    service_name="s3",
    endpoint_url=ENDPOINT,
    config=Config(signature_version="s3v4")
)

List all buckets available in your Flashback repository.

# aws_list_buckets.py
from flashback_aws_config import s3_client

response = s3_client.list_buckets()
print("Buckets in your Repository:")
for bucket in response.get("Buckets", []):
    print(f"  - {bucket['Name']}")

Upload a local file to your specified bucket:

# aws_upload.py
from flashback_aws_config import s3_client

#S3 Bucket, GCS Bucket, or Azure Container listed in your Repository
BUCKET_NAME = "your-flashback-bucket-name"
FILE_PATH = "path/to/local/file.txt"
OBJECT_NAME = FILE_PATH.split("/")[-1]

s3_client.upload_file(
    Filename=FILE_PATH,
    Bucket=BUCKET_NAME,
    Key=OBJECT_NAME
)
print(f"Uploaded {OBJECT_NAME} to {BUCKET_NAME}")