oaklabs/oakos-api repository overview

# /data/oak/coolapp/oak.yml
services:

  # your service name
  myservice:

    # define your endpoint name
    endpoint: foo/bar

    # currently only http and tcp are supported. stay tuned for more
    protocol: http
    transport: tcp

    # this is a relative path, so your server root will be /data/oak/coolapp/super/sick/files/
    # make sure to include the trailing slash if you pass an HTTP url, there are no URI rewrites

    root: super/sick/files/
    # or
    root: http://127.0.0.1:666/foo/baz/

    # file directory structure index as json. it will be in this format. Will only work for a directory structure
    #   {
    #     name: "filename.ext",
    #     type: "directory|file",
    #     mtime: "Fri, 26 Aug 2016 19:26:28 GMT"
    #   }

    index: true

    # auto advertise your service on mDNS. It will have values like so:
    #   name: myservice.oakos
    #   type: _http._tcp
    #   subtype: _myservice._sub._http._tcp
    #   txtrecord: location=thislocation
    #   txtrecord: endpoint=foo/bar

    advertise: true