https://github.com/gatsby-tv/dapper

Tool for hosting content on Gatsby.
https://github.com/gatsby-tv/dapper

cli go ipfs

Last synced: 2 days ago
JSON representation

Tool for hosting content on Gatsby.

• Host: GitHub
• URL: https://github.com/gatsby-tv/dapper
• Owner: gatsby-tv
• License: agpl-3.0
• Created: 2021-01-19T16:39:41.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-01-08T14:03:04.000Z (almost 3 years ago)
• Last Synced: 2024-12-17T03:14:16.472Z (7 days ago)
• Topics: cli, go, ipfs
• Language: Go
• Homepage:
• Size: 629 KB
• Stars: 5
• Watchers: 5
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# dapper

[![Build Status](https://travis-ci.com/gatsby-tv/dapper.svg?branch=main)](https://travis-ci.com/gatsby-tv/dapper)

Tool for adding and hosting videos on GatsbyTV.

Dapper uses IPFS to place content onto the network. It supports using an existing IPFS node to pin content, but also has the ability to run the IPFS node internally.

## Docker

Docker images are available for dapper at `gatsbytv/dapper`. Check the docker registry for available tags.

## Usage

In order to use dapper, first set the desired values in the configuration file. An example configuration file can be found [here](https://github.com/gatsby-tv/dapper/blob/main/configuration.toml.example). After it has been configured, place the configuration file in the same folder as the dapper executable, and run it with `dapper`. Dapper will then start listening for requests.

### Command Line Options

- `-p` - Port for dapper to listen for requests on.

## Building

To build dapper, simply clone this repository and run `go build` inside it. For example:

```bash

git clone https://github.com/gatsby-tv/dapper.git

cd dapper

go build

```

This will result in a `dapper` executable to be created in that folder (on Windows it will be `dapper.exe`).

## API

The dapper daemon listens for REST API requests on port 10000. This is used internally for uploading new videos, but can be communicated with directly.

### Routes

#### POST

`/video` - Add a video to Gatsby. No URL params.

Body:

```json

{

    "Title": "video title",

    "Description": "video description",

    "VideoFile": "path to video file on dapper's filesystem",

    "ThumbnailFile": "path to thumbnail file on dapper's filesystem",

}

```