Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/meztez/plumberDeploy


https://github.com/meztez/plumberDeploy

Last synced: 9 days ago
JSON representation

Awesome Lists containing this project

README 

        
---

output: github_document

---



```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```



# plumberDeploy



[![Travis build status](https://travis-ci.com/muschellij2/plumberDeploy.svg?branch=master)](https://travis-ci.com/muschellij2/plumberDeploy)

[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/muschellij2/plumberDeploy?branch=master&svg=true)](https://ci.appveyor.com/project/muschellij2/plumberDeploy)

[![R build status](https://github.com/muschellij2/plumberDeploy/workflows/R-CMD-check/badge.svg)](https://github.com/muschellij2/plumberDeploy/actions)

[![R build status](https://github.com/meztez/plumberDeploy/workflows/R-CMD-check/badge.svg)](https://github.com/meztez/plumberDeploy/actions)



The `plumberDeploy` package separated the deployment and the `do_*` functions from `plumber`.  The `plumberDeploy`  package gives the ability to automatically deploy a plumber API from R functions on 'DigitalOcean' and other cloud-based servers.



## Installation



You can install the released version of `plumberDeploy` from [CRAN](https://CRAN.R-project.org) with (coming soon!):



``` r

install.packages("plumberDeploy")

```



And the development version from [GitHub](https://github.com/) with:



``` r

# install.packages("remotes")

remotes::install_github("meztez/plumberDeploy")

```



## Setup  



If you're just getting started with hosting cloud servers, the

[DigitalOcean](https://www.digitalocean.com) integration included in `plumberDeploy`

will be the best way to get started. You'll be able to get a server hosting your

custom API in just two R commands. Full documentation is available at

https://www.rplumber.io/articles/hosting.html#digitalocean-1.



1. [Create a DigitalOcean account](https://www.digitalocean.com/?refcode=add0b50f54c4&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=CopyPaste)

2. Install `plumberDeploy`. Validate your account with `analogsea::account()`.

2. Configure an ssh key for the Digital Ocean account before using methods included in this package.

Use `analogsea::key_create` method or see https://www.digitalocean.com/docs/droplets/how-to/add-ssh-keys/to-account/.

1. Run a test command like `analogsea::droplets()` to confirm that it's able to connect to your DigitalOcean account.

1. Run `mydrop <- plumberDeploy::do_provision()`. This will start a virtual machine (or "droplet", as DigitalOcean calls them) and install Plumber and all the necessary prerequisite software. Once the provisioning is complete, you should be able to access port `8000` on your server's IP and see a response from Plumber.

1. Install any R packages on the server that your API requires using `analogsea::install_r_package()`.

1. You can use `plumberDeploy::do_deploy_api()` to deploy or update your own custom APIs to a particular port on your server.

1. (Optional) Setup a domain name for your Plumber server so you can use www.myplumberserver.com instead of the server's IP address.

1. (Optional) Configure SSL



Getting everything connected the first time can be a bit of work, but once you have `analogsea` connected to your DigitalOcean account, you're now able to spin up new Plumber servers in DigitalOcean hosting your APIs with just a couple of R commands. You can even write [scripts that provision an entire Plumber server](https://github.com/meztez/plumberDeploy/blob/master/inst/hosted-new.R) with multiple APIs associated.



Your ssh key needs to be available on your local machine too. You can

check this with `ssh::ssh_key_info()`. Validate that one of the public

keys can be found in `lapply(analogsea::keys(), '[[', "public_key")`.



## Deploy an api to a new droplet



`.api/plumber.R`

```R

#* @get /

function() {

  Sys.Date()

}

```

Then run this code

```R

id <- plumberDeploy::do_provision(example = FALSE)

# About 10 minutes

# STOP Make sure every packages the api depends on is available on the droplet, see below for other commands.

plumberDeploy::do_deploy_api(id, "date", "./api/", 8000, docs = TRUE)

```



Navigate to: `[[IPADDRESS]]/date/__docs__/`



## Other useful commands

```R

# Install package to your droplet

analogsea::install_r_package(droplet, c("readr", "remotes"))

# Install system dependencies to your droplet

analogsea::debian_apt_get_install(droplet, "libssl-dev","libsodium-dev", "libcurl4-openssl-dev")

```



R Packages installed on linux systems sometimes require system packages. Check console output carefully to see if a package was installed successfully.



Otherwise read the doc on functions, ask questions in the [RStudio community](https://community.rstudio.com/) or report issues to our github issue tracker.