Quickstart
Warning: This guide is mainly for testing purpose. For security reasons, we highly recommend to follow these guides for a production setup.
Here is a list a quick tutorials to start efficiently with Flashback:
Start Quickly with Cloud Storage
Follow these steps to start quickly to store with Flashback:
Need Python 3.9 and higher
Install the right dependencies such as Boto3
And have a Flashback account 😄
Signin and login
Sign in at platform.flashback.tech with an e-mail and a password.
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 Cloud 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.
Create your first repository
In the left-hand menu, go to Repositories → Inventory.
Click the Create 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.
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.
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 KEY API Information of the Repository using S3 endpoint
API_KEY_ID = "AKIA..."
API_SECRET = "5G..."
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}")
Start Quickly with AI LLM
Coming Soon.
Last updated
Was this helpful?