Skip to content
ricochet
Search limited to 0.4. Switch to the latest version for up-to-date results.

Quickstart

Deploy your first app in minutes using our public trial instance at try.ricochet.rs. Note that the trial instance is wiped weekly. Do not use it for production purposes.

  1. Create an account at try.ricochet.rs

    Or, you can login to your private instance.

  2. Install the ricochet CLI

    The ricochet CLI is used to deploy items to your ricochet server.

    Terminal window
    curl -fsSL https://raw.githubusercontent.com/ricochet-rs/cli/main/install.sh | sh

  3. Login to the ricochet instance

    The -S flag is used to specify the server url you are logging into.

    Terminal window
    ricochet login -S https://try.ricochet.rs

  4. Deploy a Shiny app

    First, clone an example Shiny app and navigate to it:

    Terminal window
    git clone https://github.com/rstudio/shiny-examples.git /tmp/shiny-examples
    cd /tmp/shiny-examples/050-kmeans-example/

    Now deploy the app:

    Terminal window
    ricochet deploy

    You’ll be prompted to create a _ricochet.toml file. This file is required for deploying to ricochet and tracks your item’s configuration.

    Enter yes.

  5. Select the language

    Choose R from the language options (R, Julia, or Python).

    ? Choose a language › R

  6. Select the content type

    Choose Shiny from the content type options. You can type “sh” to filter the list.

    ? Choose content type › Shiny

  7. Specify the entrypoint

    The entrypoint is the file or folder that starts your app. For this example, select app.R.

    ? Select Shiny app entrypoint › app.R

  8. Give the item a name

    Enter a display name for your app. This name appears in the ricochet UI.

    ? Content item name › My First Shiny App

  9. Set the item’s visibility

    Choose who can access your app:

    • Private: Only you and specified users
    • Internal: Only logged-in users
    • External: Public-facing, no authentication

    For this quickstart, select External.

    ? Item visibility › External

  10. Deployment started!

    Terminal window
    📦 Deploying new Shiny content item
    

    ✓ Deployment successful!
    

    Links:
    Deployment: https://try.ricochet.rs/deployments/01KE2F8DC4FGNZKGNR6NTW0BK6
    App Overview: https://try.ricochet.rs/apps/01KE2F8DC0NPEMA6TSD4EA1MY4/overview

    Open the Deployment link above to watch your package environment restore! Once the deployment is complete, the app can be viewed.