# Starling

Starling is a decentralized storage application designed for use in archival settings, where the ability to demonstrate the authenticity of a file over the course of time is of paramount importance.


# Getting started

This guide will quickly set up Starling on your computer.

# Prerequisites

You need to have a couple of things installed before you can interact with Starling:

  1. Lotus.
  2. NodeJS (opens new window) version 12.19 or higher.

# Steps

  1. Ensure that the Lotus daemon is running, and has fully synced.

  2. In a new terminal window, get your Lotus API token and endpoint with:

    lotus auth api-info --perm admin
    > FULLNODE_API_INFO=eyJhbGcabdjwieusyiIsInR5cCI6IkpXVCJ9.eyJBbGxvdyI6WyJyZWFkIiwid3JpdGUiLCJzaWduIiwdj3isu2938X0.tmdXnxUflc8nhghfjiwo2l1o9T1QwT0jLskdEV5cYEc:/ip4/
  3. Clone the Starling repository:

    git clone https://github.com/filecoin-project/starling
  4. Move into the starling directory and install the dependencies:

    cd starling
    npm install
    sudo npm link
  5. Configure Starling settings:

    starling config
  6. You are ready to run Starling!

    a. Store a single file run:

    starling store full/path/to/file

    b. Store a folder run:

    starling store full/path/to/folder

    c. Launch the interactive monitoring interface:

    starling monitor

Check the official documentation (opens new window) for a more in-depth look into what Starling can do.