Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve and document how to use the distribution as a remote renderer #333

Closed
xlson opened this issue Mar 2, 2022 · 0 comments
Closed
Labels
type/docs type/enhancement New feature or request

Comments

@xlson
Copy link
Contributor

xlson commented Mar 2, 2022

What would you like to be added:

  1. Change the documentation to cover how to use the plugin zip to run the image renderer.
  2. Improve the image renderer when running in remote mode from the plugin distribution so that it finds the bundled chrome install by default.

A short guide to running the plugin in remote mode

It's possible to run the plugin in server mode and use it as a remote renderer, just download the latest zip unpack it. Running it requires pointing to the chrome binary.

Create config.json file in plugin folder to point to the chrome binary and possibly add other config (see docs for further details).

{
    "rendering": {
        "chromeBin": "./chrome-linux/chrome-wrapper"
    }
}

Run remote renderer:

./plugin_start_linux_amd64 server --config=config.json

Why is this needed:

I want it to be easy to use the remote renderer, running from source is great for development but not ideal in production. It's also important that our users run a specific release of the image renderer so that we can help debug problems, which is also hard when running from source as it's unlikely that a specific version is being used.

@xlson xlson added type/enhancement New feature or request type/docs labels Mar 2, 2022
@xlson xlson closed this as completed Sep 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs type/enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant