Title:	Generate Dockerfiles for 'Shiny' Applications
Version:	0.0.3
Description:	Automates the creation of Dockerfiles for deploying 'Shiny' applications. By integrating with 'renv' for dependency management and leveraging Docker-based solutions, it simplifies the process of containerizing 'Shiny' apps, ensuring reproducibility and consistency across different environments. Additionally, it facilitates the setup of CI/CD pipelines for building Docker images on both GitLab and GitHub.
License:	MIT + file LICENSE
Imports:	attachment (≥ 0.4.3), cli, dockerfiler, here, yesno
Encoding:	UTF-8
RoxygenNote:	7.3.2
URL:	https://github.com/VincentGuyader/shiny2docker
BugReports:	https://github.com/VincentGuyader/shiny2docker/issues
Suggests:	shiny, renv, testthat (≥ 3.0.0), knitr, rmarkdown, rstudioapi
Config/testthat/edition:	3
VignetteBuilder:	knitr
NeedsCompilation:	no
Packaged:	2025-06-28 20:54:19 UTC; PC
Author:	Vincent Guyader [aut, cre]
Maintainer:	Vincent Guyader <vincent@thinkr.fr>
Repository:	CRAN
Date/Publication:	2025-06-28 21:10:02 UTC

Configure GitHub Action pipeline for Docker builds

Description

Copies the docker-build.yml file provided by the shiny2docker package into the .github/workflows/ directory within the specified base directory. This GitHub Action configuration is designed to build a Docker image and push the created image to the GitHub Container Registry.

Usage

set_github_action(path)

Arguments

Value

A logical value indicating whether the file was successfully copied (TRUE) or not (FALSE).

Examples

# Copy the docker-build.yml file to the .github/workflows/ directory in a temporary folder
set_github_action(path = tempdir())

Configure GitLab CI pipeline for Docker builds

Description

Copies the .gitlab-ci.yml file provided by the shiny2docker package into the specified directory. The GitLab CI configuration is designed to build a Docker image and push the created image to the GitLab container registry.

Usage

set_gitlab_ci(path, tags = NULL)

Arguments

Value

A logical value indicating whether the file was successfully copied (TRUE) or not (FALSE).

Examples

# Copy the .gitlab-ci.yml file to a temporary directory
set_gitlab_ci(path = tempdir())

# Copy the file and specify runner tags
set_gitlab_ci(path = tempdir(), tags = c("shiny_build", "prod"))

shiny2docker

Description

Generate a Dockerfile for a Shiny Application

Usage

shiny2docker(
  path = ".",
  lockfile = file.path(path, "renv.lock"),
  output = file.path(path, "Dockerfile"),
  FROM = "rocker/geospatial",
  AS = NULL,
  sysreqs = TRUE,
  repos = c(CRAN = "https://cran.rstudio.com/"),
  expand = FALSE,
  extra_sysreqs = NULL,
  use_pak = FALSE,
  user = NULL,
  dependencies = NA,
  sysreqs_platform = "ubuntu",
  folder_to_exclude = c("renv")
)

Arguments

Details

Automate the creation of a Dockerfile tailored for deploying Shiny applications. It manages R dependencies using renv, generates a .dockerignore file to optimize the Docker build process, and leverages the dockerfiler package to allow further customization of the Dockerfile object before writing it to disk.

Value

An object of class dockerfiler, representing the generated Dockerfile. This object can be further manipulated using dockerfiler functions before being written to disk.

Examples

  temp_dir <- tempfile("shiny2docker_example_")
  dir.create(temp_dir)
  example_app <- system.file("dummy_app", package = "shiny2docker")
  file.copy(example_app, temp_dir, recursive = TRUE)

  app_path <- file.path(temp_dir, "dummy_app")
  if (requireNamespace("rstudioapi", quietly = TRUE) &&
  rstudioapi::isAvailable()) {
    rstudioapi::filesPaneNavigate(app_path)
  }

  docker_obj <- shiny2docker::shiny2docker(path = app_path)

  print(list.files(app_path,all.files = TRUE,no.. = TRUE))

  # Further manipulate the Dockerfile object
 docker_obj$add_after(
   cmd = "ENV ENV \'MY_ENV_VAR\'=\'value\'",
   after = 3
 )
 docker_obj$write(file.path(app_path, "Dockerfile"))