diff --git a/NEWS.md b/NEWS.md index eff2f8ba..9afc31cb 100644 --- a/NEWS.md +++ b/NEWS.md @@ -4,6 +4,8 @@ * Fixed a bug in how `pin_upload()` handles pin names (#852). +* Improved documentation for S3-compatible object storage (#853). + # pins 1.4.0 ## Lifecycle changes diff --git a/R/board_s3.R b/R/board_s3.R index 565cfd00..62013337 100644 --- a/R/board_s3.R +++ b/R/board_s3.R @@ -1,7 +1,7 @@ #' Use an S3 bucket as a board #' -#' Pin data to an S3 bucket, such as on Amazon's S3 service or MinIO, using the -#' paws.storage package. +#' Pin data to an S3-compatible storage bucket, such as on Amazon's S3 service, +#' MinIO, or Digital Ocean, using the paws.storage package. #' #' # Authentication #' @@ -48,6 +48,9 @@ #' * You can pass arguments for [paws.storage::s3_put_object] such as `Tagging` #' and `ServerSideEncryption` through the dots of `pin_write()`. (Note that #' these are separate from [pin_write()] arguments like `tags`.) +#' * You can use `board_s3()` with S3-compatible object storage on non-AWS +#' platforms such as MinIO and Digital Ocean. For this type of object storage, +#' use the full URL (including scheme like `https://`) of the storage endpoint. #' * `board_s3()` is powered by the paws.storage package, which is a #' suggested dependency of pins (not required for pins in general). If #' you run into errors when deploying content to a server like @@ -66,8 +69,8 @@ #' @param region AWS region. If not specified, will be read from `AWS_REGION`, #' or AWS config file. #' @param endpoint Endpoint to use; usually generated automatically for AWS -#' from `region`. For MinIO, use the full URL (including scheme like -#' `https://`) of your MinIO endpoint. +#' from `region`. For MinIO and Digital Ocean, use the full URL (including +#' scheme like `https://`) of your S3-compatible storage endpoint. #' @param profile Role to use from AWS shared credentials/config file. #' @export #' @examples diff --git a/man/board_s3.Rd b/man/board_s3.Rd index bfdba7d4..b94335c1 100644 --- a/man/board_s3.Rd +++ b/man/board_s3.Rd @@ -36,16 +36,16 @@ S3's directory-like handling.} or AWS config file.} \item{endpoint}{Endpoint to use; usually generated automatically for AWS -from \code{region}. For MinIO, use the full URL (including scheme like -\verb{https://}) of your MinIO endpoint.} +from \code{region}. For MinIO and Digital Ocean, use the full URL (including +scheme like \verb{https://}) of your S3-compatible storage endpoint.} \item{cache}{Cache path. Every board requires a local cache to avoid downloading files multiple times. The default stores in a standard cache location for your operating system, but you can override if needed.} } \description{ -Pin data to an S3 bucket, such as on Amazon's S3 service or MinIO, using the -paws.storage package. +Pin data to an S3-compatible storage bucket, such as on Amazon's S3 service, +MinIO, or Digital Ocean, using the paws.storage package. } \section{Authentication}{ \code{board_s3()} is powered by the paws package which provides a wide range @@ -89,6 +89,9 @@ return useful output. \item You can pass arguments for \link[paws.storage:s3_put_object]{paws.storage::s3_put_object} such as \code{Tagging} and \code{ServerSideEncryption} through the dots of \code{pin_write()}. (Note that these are separate from \code{\link[=pin_write]{pin_write()}} arguments like \code{tags}.) +\item You can use \code{board_s3()} with S3-compatible object storage on non-AWS +platforms such as MinIO and Digital Ocean. For this type of object storage, +use the full URL (including scheme like \verb{https://}) of the storage endpoint. \item \code{board_s3()} is powered by the paws.storage package, which is a suggested dependency of pins (not required for pins in general). If you run into errors when deploying content to a server like