npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

run-remote-task

v0.5.0

Published

Runs tasks on a remote machine with communication over a WebDAV server.

Downloads

1,276

Readme

Run remote task

Runs tasks on a remote machine with communication over a WebDAV server.

All messages are signed, which means you can use it even if you don't trust the WebDAV server. If data is modified in between, the task won't be executed or the result won't be accepted. It's also fine to use HTTP, unless you're concerned about data being accessible to someone else.

How it works

This diagram explains the interaction without going too deep into details:

Usage

  1. Generate two keypairs:

    openssl genrsa -out private-key-client.pem 2048
    openssl rsa -in private-key-client.pem -outform PEM -pubout -out public-key-client.pem
       
    openssl genrsa -out private-key-server.pem 2048
    openssl rsa -in private-key-server.pem -outform PEM -pubout -out public-key-server.pem
  2. Upload the keys:

    • to client boxes:
      • private-key-client.pem
      • public-key-client.pem
      • public-key-server.pem
    • to the server box:
      • private-key-server.pem
      • public-key-client.pem
      • public-key-server.pem
  3. Create a json config:

    {
        "server": "http://your-webdav-server/with-path/",
        "user": "webdav-user",
        "password": "webdav-password",
        "clientPublicKey": "path/to/public-key-client.pem",
        "serverPublicKey": "path/to/public-key-server.pem",
        "clientPrivateKey": "path/to/private-key-client.pem",
        "serverPrivateKey": "path/to/private-key-server.pem",
        "pollMillis": 5000,
        "taskExpirationMillis": 600000,
        "command": "run_task.sh",
        "commandRetries": 10
    }

    If you're using Google Cloud Storage:

    {
        "gcp": {
            "projectId": "my-project",
            "bucketName": "my-bucket",
            "credentials": {
                "client_email": "...",
                "private_key": "..."
            }
        },
        "clientPublicKey": "path/to/public-key-client.pem",
        "serverPublicKey": "path/to/public-key-server.pem",
        "clientPrivateKey": "path/to/private-key-client.pem",
        "serverPrivateKey": "path/to/private-key-server.pem",
        "pollMillis": 5000,
        "taskExpirationMillis": 600000,
        "command": "run_task.sh",
        "commandRetries": 10
    }

    If you're using AWS S3:

    {
        "aws": {
            "accessKeyId": "...",
            "secretAccessKey": "...",
            "region": "eu-central-1",
            "bucket": "my-bucket"
        },
        "clientPublicKey": "path/to/public-key-client.pem",
        "serverPublicKey": "path/to/public-key-server.pem",
        "clientPrivateKey": "path/to/private-key-client.pem",
        "serverPrivateKey": "path/to/private-key-server.pem",
        "pollMillis": 5000,
        "taskExpirationMillis": 600000,
        "command": "run_task.sh",
        "commandRetries": 10
    }

    Upload this config to both server and clients.

  4. Write your task in run_task.sh. Your task receives two environment variables:

    • INPUT: file with input data received from the client
    • OUTPUT: expected output file name that will be sent back

    Here's a hello world example:

    name=$(<$INPUT); echo "Hello, $name!">$OUTPUT
  5. Run the server:

    npx run-remote-task --config=config.json --server
  6. Test the client:

    npx run-remote-task --config=config.json --client --input=input.txt

License

MIT