Manipulating Images Microservice (MIMS) - v2

MIMS is a microservice API which processes images using Node.js. This microservice uses about 500mb of ram when starting out and can be up to 900mb or more due to the number of requests you have. A default of 3 processes is created (see config.json). Processes are indeed heavy. Only create more if you really need the concurency. You may need fewer or more depending on your use case. If that's the case then you must specify that when running docker by changing the number of processes in your config.json file.

If your node version is less than 11.5 you must use node --experimental-worker app.js and install the 1 million dependencies (use the Dockerfile and Docker!)

You can test a live instance here (you will be rate limited): beta-mims.bongo.best

Installation and Running

To install docker on linux (ubuntu or debian): curl -sSL https://get.docker.com/ | bash
Otherwise, look it up.

Then simply run a docker command targeting my image on docker hub: docker rm -f mims || true && docker run -p 8443:8443 -d --restart=always --memory="1024m" --name mims joshgor01/image-microservice:beta.

If you want dev branch changes, or check the other images at: https://hub.docker.com/repository/docker/joshgor01/image-microservice

Then you can view the logs with docker logs -f mims.

How To Use

To use this microservice you must make a POST request to the provided endpoints and make sure you have the correct args provided. In other words, look into each file under /src/endpoints and look at the structure.

The name is the endpoint.
The filepath is the location of the file I use to read in the buffer (you don't need to worry about this unless making your own).
The args are the list of arguments that MUST be met in order to process your image. Otherwise you will get a 400 bad request.
You will receive back a buffer of the image if success. Otherwise error messages will be returned.

Examples

I use this with request-promise.

options = {
    method: 'POST',
    uri: 'http://localhost:8443/api/' + endpoint, //endpoint is the image (see below)
    encoding: null,
    headers: {
        'Content-type': 'application/json'
    },
    body: body,
    json: true
};

If you do not want a buffer and want a string (say the ascii endpoint), set your options to

const options =  {
    method: 'POST',
    uri: 'http://localhost:8443/api/ascii',
    body: body,
    json: true
};

Here are some examples with the body.

The hot endpoint requires the image_url
localhost:8443/api/hot

POST /api/hot HTTP/1.1
Host: localhost:8443
Content-Type: application/json

{"image_url": "https://pbs.twimg.com/media/DtwaeFtUwAAPbxk.jpg"}

The hatkidsays endpoint requires text
localhost:8443/api/hatkidsays

POST /api/hatkidsays HTTP/1.1
Host: localhost:8443
Content-Type: application/json

{"text": "Make sure you brush your teeth!"}

The halloweenify endpoint requires an image url and a threshold.
localhost:8443/api/halloweenify

POST /api/halloweenify HTTP/1.1
Host: localhost:8443
Content-Type: application/json

{"image_url": "https://pbs.twimg.com/media/DtwaeFtUwAAPbxk.jpg", "threshold": "1"}

Contributing

I would recommend using the local.Dockerfile like so: docker rm -f mims || true && docker build -t mims . -f local.Dockerfile && docker run -p 8443:8443 -d --restart=always --memory="1024m" --name mims mims

Pull Requests