Welcome to Juno's File Service! This guide will walk you through the steps required to integrate Juno’s file microservice into your project. By following this documentation, your team will be able to set up, configure, and manage files directly through Juno’s SDK.

This guide will focus solely on the File Service SDK interactions. If you are interested in interacting with the Juno API via Rest, please refer to the Juno Documentation. When a new release of Juno is deployed, all documentation will be automatically regenerated to ensure it stays up to date.

Prerequisites

1. Access to Juno: Ensure you have access to the Juno SDK. You’ll need an API key specific to your project to interact with the file service.
2. Project Registration: Your project should already be registered in Juno. If it’s not, please refer to the Infra Project Registration Guide to get set up.
3. API Key: You will need an API key generated for your project. This key allows you to authenticate API requests.
4. Install and Import Juno SDK:

npm install juno-sdk # for projects using npm
pnpm add juno-sdk # for projects using pnpm
yarn add juno-sdk # for projects using yarn
bun install juno-sdk # for projects using bun

import juno from "juno-sdk";

// Call this somewhere in your program before using any of Juno's services
juno.init({
  apiKey: "<your api key>",
  baseUrl: "<base url of running juno instance>"
});

// We can then call any of the service methods, e.g. email, file services

Data Models

Please take a moment to review the model structure of the File Service. The File Service organizes files using the following hierarchy:

• File Config: consists of project ID and config environment. Each file config defines an environment (development, staging, production, test, etc) your project’s file service is currently maintaining
• File Provider: consists of provider name, access keys, provider base URL, and metadata, indicating which cloud provider (S3, Azure, etc) is used to manage the files
• File Bucket: consists of bucket name. Think of it as a folder containing the files
• File: consists of file ID and metadata, representing a file that can be uploaded/downloaded

Step 1: Configure Juno File Services

Begin by setting up the file service configuration for your project. This involves creating a file config object that includes your project ID and target environment, which will then be saved to the Juno Database.