Codiusd (Codius Daemon) is the server-side component of Codius
Codius is an open-source decentralized hosting platform using Interledger. It allows anyone to run software on servers all over the world and pay using any currency. Users package their software inside of containers. Multiple containers can run together inside of a pod.
Codiusd (Codius Daemon; this software) is the server-side component. You can run one or more codiusd hosts in your datacenter and Codius clients will pay you to run their software. Codiusd uses hyperd to provide hardware-level isolation between different pods.
First, you need to install hyperd. Once hyperd is installed, please make sure it is working correctly:
Command line
sudo hyperctl run -t hello-world
Expected Output
$ sudo hyperctl run -t hello-worldUsing default tag: latestlatest: Pulling from library/hello-world9bb5a5d4561a: Pull completeDigest: sha256:f5233545e43561214ca4891fd1157e1c3c563316ed8e237750d59bde73361e77Status: Downloaded newer image for hello-world:latestsha256:f5233545e43561214ca4891fd1157e1c3c563316ed8e237750d59bde73361e77: Pulling from library/hello-worldDigest: sha256:f5233545e43561214ca4891fd1157e1c3c563316ed8e237750d59bde73361e77Status: Downloaded newer image for hello-world@sha256:f5233545e43561214ca4891fd1157e1c3c563316ed8e237750d59bde73361e77Hello from Docker!This message shows that your installation appears to be working correctly.To generate this message, Docker took the following steps: 1. The Docker client contacted the Docker daemon. 2. The Docker daemon pulled the "hello-world" image from the Docker Hub. (amd64) 3. The Docker daemon created a new container from that image which runs the executable that produces the output you are currently reading. 4. The Docker daemon streamed that output to the Docker client, which sent it to your terminal.To try something more ambitious, you can run an Ubuntu container with: $ docker run -it ubuntu bashShare images, automate workflows, and more with a free Docker ID: https://hub.docker.com/For more examples and ideas, visit: https://docs.docker.com/engine/userguide/
If you don't see the "Hello from Docker!" message, please troubleshoot your hyperd installation before proceeding.
Once hyperd is installed and working, you can install Codius Host.
sudo npm install -g codiusd
Environment Variables
CODIUS_COST_PER_MONTH
Type: Integer
Description: A monthly rate the host charges (in XRP) to host a program. Codiusd calculates this value down to the rate per second, as uploads are given a time in seconds to be hosted for.
Default: 10
CODIUS_HYPER_SOCKET
Type: String
Description: The absolute path to the hyperd socket.
Description: The port that codiusd will listen on.
Default: 3000
CODIUS_PUBLIC_URI
Type: String
Description: The public URI resolving to this instance of codiusd.
Default: http://local.codius.org:CODIUS_PORT
CODIUS_MAX_MEMORY_FRACTION
Type: Number
Description: Amount of memory to allocate to codiusd for hosting.
Default: 0.75
CODIUS_ADDITIONAL_HOST_INFO
Type: Boolean
Description: Gives info about the host such as uptime, contracts currently running, monthly fee, etc. You can view this info at the /info endpoint, e.g. codius.example.com/info
Default: true
CODIUS_BOOTSTRAP_PEERS
Type: JSON Array
Description: List of peers whose values are the URIs that resolve to their Codius instance.
Default: [ ]
API Documentation
POST /pods?duration=TIME_TO_LIVE
Create a pod that runs a given Codius Manifest and purchases the amount of time that the host will run it using Interledger
Request Body:
Type: Object
Field Name
Type
Description
manifest
Object
An object containing a manifest for your code. The format can be found here.
private
Object
An object containing private variables you want to pass to the host, such as an AWS key. An example can be found as part of the manifest format here.
Return Value:
Type: Object
Field Name
Type
Description
url
string
A URL resolving to the ip address of the pod that was just created. It is comprised of the pod's manifest hash followed by the hostname of the codius host.
manifestHash
string
The hash of the manifest that was passed to the Codius host.
expiry
string
A timestamp of when the pod will expire.
Variables:
duration: Time in seconds for the Codius host to run your code. Makes an Interledger payment to buy the requested amount of time. Required.
GET /pods/{MANIFEST_HASH}/logs?follow={true/false}
Retrieve the most recent data in the standard output of a running pod, as specified by MANIFEST_HASH.
NOTE: Only pods whose manifests contain debug: true in their manifest objects will be compatible with this endpoint.
Return Value:
Type: Stream
Description: A stream containing the most recent data written to the standard output of a given pod.
Variables:
follow: A boolean value that, when set to true, will continue to follow the output of the specified pod's standard output in real time.
GET /peers
Returns the peers currently known to this host.
Return Value:
Type: Array[String]
Description: An array of size 10 containing peers known to the Codius Host.
POST /peers/discover
Queries other Codius hosts for the peers known to each of them.
Request Body
Type: Object
Field Name
Type
Description
peers
Array[string]
An array of URIs of Codius hosts to query for additional peers.
Return Value
Type: Object
Field Name
Type
Description
name
string
Name of the implementation of Codius that the host is running. In this case it is 'Codiusd (Javascript)'
version
string
The version of Codiusd that the host is running, as described in package.json.
peers
Array[string]
An array of peers known to the set of queried Codius hosts.
GET /version
Type: Object
Field Name
Type
Description
name
string
Name describing the name of the Codius implementation that the host is running. In this case it is 'Codiusd (Javascript)'
version
string
The version of Codiusd that the host is running, as described in package.json.
Open Issues
Block network traffic between pods by default
Add plugin decorator to Hapi.Request type
Figure out encoding to hash manifest
How to escape the variable interpolation in manifest parser
How to fill in the values for private sha256 variables
Switch hyperctl to hyper.sock http requests
Check whether hyper instance is still running before adding duration
How do pods spend money?
add port field
add private field to manifest's parent object
add nonce to the private field spec
port blocking on dangerous ports
change manifest hash encoding to base32
publish @sharafian/cog and pull from actual npm
proxy endpoints based on manifest hash to the contract's IP