Remote Executor (REX)

This project aim to be a dynamic endpoint for remote code execution (for example to deploy something on another machine from CI/CD, without having to use SSH to login).

Installation

Docker Compose

version: '3.5'

services:
  rex:
    image: mauricenino/rex
    restart: unless-stopped
    ports:
      - '80:3000'
    volumes:
      - /path/to/scripts:/scripts:ro
      - /var/run/docker.sock:/var/run/docker.sock:ro # Only if you want to control docker containers from rex
    environment:
      REX_SECRET: 'some_secret_token'

Docker

docker container run -it \
  -p 80:3000 \
  -v /path/to/scripts:/scripts:ro \
  -v /var/run/docker.sock:/var/run/docker.sock:ro \
  -e REX_SECRET="some_secret_token" \
  mauricenino/rex

Shell

git clone https://github.com/MauriceNino/rex \
  && cd rex \
  && yarn \
  && yarn build \
  && REX_SCRIPT_PATH="/path/to/scripts" REX_SECRET="some_secret_token" yarn start

Usage

In your REX_SCRIPT_PATH you can place .js files with a structure like so:

// deploy.js
module.exports = ({ route, exec, log }) =>
  route
    .settings({
      sendLogs: true, // Send logs as response to the HTTP call
    })
    .param('service', {
      options: ['rex', 'some_other_service'],
    })
    .param('image', {
      options: ['mauricenino/rex:*'],
    })
    .onCall(async options => {
      const service = options.service.value;
      const image = options.image.value;

      log.info(`Deploying ${service} with image ${image}`);

      await exec(`
        docker image pull ${image} &&\\
        docker compose up -d ${service}
      `);
    });

Which you can then call via a simple HTTP call:

curl --get \
  --data-urlencode "service=rex" \
  --data-urlencode "image=mauricenino/rex:latest" \
  --data-urlencode "secret=some_secret_token" \
  https://rex.mauz.dev/deploy