Skip to content

Latest commit

 

History

History

storage

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Apillon IPFS Storage Service - IPFS

Storage and IPFS service provides endpoint for uploading and managing user's files. User files are stored into "bucket" virtual folder. Files from buckets are eventually stored to IPFS node and distributed on Crust network. Buckets can also be used for hosting static web pages on IPFS network.

Storage service also uses background worker processes for uploading to IPFS nodes and communicating with Crust blockchain.

Table of Contents

  1. Getting Started
  2. Configuration
  3. Deployment
  4. License

Getting Started

Please read Development and Debug and Test documentation. These instructions will help you set up the development environment and run the microservice locally.

Configuration

Environment variables that have to be set:

/************************************************************
 * IPFS - Apillon Storage Service
 ************************************************************/
STORAGE_FUNCTION_NAME: string;
STORAGE_FUNCTION_NAME_TEST: string;
STORAGE_SOCKET_PORT: number;
STORAGE_SOCKET_PORT_TEST: number;
STORAGE_CRUST_SEED_PHRASE: string;
STORAGE_CRUST_SEED_PHRASE_TEST: string;
STORAGE_AWS_IPFS_QUEUE_BUCKET: string;

STORAGE_MYSQL_HOST: string;
STORAGE_MYSQL_PORT: number;
STORAGE_MYSQL_USER: string;
STORAGE_MYSQL_PASSWORD: string;
STORAGE_MYSQL_DEPLOY_USER: string;
STORAGE_MYSQL_DEPLOY_PASSWORD: string;
STORAGE_MYSQL_DATABASE: string;

STORAGE_MYSQL_HOST_TEST: string;
STORAGE_MYSQL_PORT_TEST: number;
STORAGE_MYSQL_USER_TEST: string;
STORAGE_MYSQL_PASSWORD_TEST: string;
STORAGE_MYSQL_DATABASE_TEST: string;

/************************************************************
 * Serverless workers config - STORAGE MS
 ************************************************************/
STORAGE_AWS_WORKER_SQS_URL: string;
STORAGE_AWS_WORKER_SQS_ARN: string;
STORAGE_AWS_WORKER_LAMBDA_NAME: string;

IPFS cluster, api and gateway

Apillon supports multiple ipfs clusters. Each cluster has one or more ipfs nodes, ssl proxy and load balancer (not necessary). Ipfs clusters are stored in ipfs_cluster table and by default storage MS uses cluster which has isDefault property set to 1.

Custom cluster for project can be set in project_config table.

Deployment

Please read Deployment documentation.

License

Copyright (c) Apillon - all rights reserved