ReadMe.md

RSS 3 Go Hub

You are the hub, of all you have, of all you love. Keep going.

About

It's still in early develop stage, and those it may have some functional questions. Just open an issue if necessary.

Check RSS3-Hub and RSS3 for more information.

Deploy

You can use docker and docker-compose for quick deployments now.

# Grab the docker-compose file
wget https://raw.githubusercontent.com/nyawork/rss3go-hub/dev/docker-compose.yml

# Grap default configuration file
wget https://raw.githubusercontent.com/nyawork/rss3go-hub/dev/config.yml

# Now you can edit those files as you like.

Sometimes we may change the above two yml file for more functional implements. Don't forget to check them out!

To start up RSS3Go-Hub or for further upgrade, just run follow commands:

# Pull image
docker-compose pull

# Start container
docker-compose up -d

Authentication

For better compatibility, we are using the same methods for signature authentication in RSS3-Hub.

They are already implemented in rss3go-lib.

Endpoints

Files

• GET /files/:fid - get a file

  Request body: Null

• PUT /files - change a file (Signature within)

  Request body: Arrays of file object with signature (Might already exist)

  {
    "contents": [{
        "id": "0x.......",
        "...": "..."
    }, {
        "id": "0x.......",
        "...": "..."
    }]
  }

• DELETE /files - delete a file (Signature within)

  Request body: (Your hexadecimal signature of string "delete")

  {
      "signature": "xxxxxx00" // Should end with 00 or 01
  }