# 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.


# Get started with Starling

  1. Starling uses Lotus to interact with the Filecoin network. download, install and run a Lotus daemon:

    Make sure that Lotus is running and the find out about your Lotus API token and endpoint with:

    lotus auth api-info --perm admin

    This will print a FULLNODE_API_INFO=<token>:/ip4/<port>/http string that we will use later.

  2. Install NodeJS (opens new window):

    You will need a recent version of nodejs and npm (>=2.19).

  3. Install Starling:

    You can do it from source with:

    # Checkout the repository
    git clone https://github.com/filecoin-project/starling
    cd starling
    # Install dependencies
    npm install
    sudo npm link
  4. Configure Starling:

    Make sure your environment defines the location of the Lotus API and the token to use:

    # As provided by the `api-info` command we ran before
    export LOTUS_URL=ws://
    export LOTUS_AUTH_TOKEN=<token>

    Configure startling settings by running:

    starling config
  5. You are ready to run Starling!

    # Store a single file
    starling store full/path/to/file
    # Store a folder
    starling store full/path/to/folder
    # Launch interactive monitoring interface
    starling monitor

    Check the official documentation (opens new window) for a list of commands and what they can do.