Contributing

Development getting started

Prerequisites

Development

Depends on are you going to develop the CLI client or the API how you should proceed.

eli

Easiest way is to just run with go run

go run ./cmd/eli/* <command>

eliotd

To run fully functioning eliotd, you need filesystem access for example to create FIFO files for container logs. You can develop some of the features by tunneling the containerd socket connection from the device to your local computer.

# leave open
ssh <user@device-ip> -L /run/containerd/containerd.sock:/run/containerd/containerd.sock

# In another window
go run ./cmd/eliotd/*

Test

You can run tests inside container so you don't need to install all tools locally

make test

Documentation

If you want to improve the documentation, you can run locally the gitbook

**[terminal]
**[prompt ernoaapa@mac]**[path ~/go/src/github.com/ernoaapa/eliot]**[delimiter  $ ]**[command npm install -g gitbook]
**[prompt ernoaapa@mac]**[path ~/go/src/github.com/ernoaapa/eliot]**[delimiter  $ ]**[command gitbook --lrport=3001 serve]

Open http://localhost:4000

Debugging

Log file locations

If you use EliotOS, you can find eliotd logs from /var/log directory.

results matching ""

    No results matching ""