README.md

Canary

Requirements

• Linux/Mac(Docker for Mac)

Run

Linux/macOS

docker build -t canary .
docker run -d -v $PWD/data:/opt/canary/data -v /var/run/docker.sock:/var/run/docker.sock canary

Development(with dockerd container)

docker-compose build
docker-compose up -d

Tips

If you are building for development, adding USE_HOST_VENDOR=1 in .env will keep files in vendor/ and skip dep ensure step.

Test

./test.sh

Directory structure

├── canary
│   ├── data/       -- App data
│   ├── plugins/    -- Default plugins
│   ├── scripts/    -- Development tools
│   └── ...