Tools to Work with the 'Splash' JavaScript Rendering Service in R
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

37 lines
1.2 KiB

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/docker-splash.r
\title{Start a Splash server Docker container}
start_splash(host = harbor::localhost, add_tempdir = FALSE)
\item{host}{Docker host; defaults to `localhost`}
\item{add_tempdir}{This is `FALSE` initially since you could try to run
the splash image on a remote system. It has to be a local one for this to work.
If `TRUE` then a local temporary directory (made with [tempdir]())
will be added to the mount configuration for use with [render_file](). You will need to
ensure the necessary system temp dirs are accessible as a mounts. For
macOS this means adding `/private` to said Docker config.}
`harbor` `container` object
If using this in an automation context, you should consider adding a
`Sys.sleep(3)` (or higher) after starting the docker container.
you need Docker running on your system and have pulled the container with
[install_splash] for this to work. You should save the resultant `host`
object for use in [stop_splash].
splash_container <- start_splash()