Skip to main content

Overview

This document serves as an internal wiki, providing guidelines and best practices for leveraging Retool effectively at our organisation's Centre of Excellence. It aims to empower users with the knowledge and resources necessary to streamline their Retool usage and build powerful business applications.

Getting Help and Support​

If you require assistance or have any questions regarding Retool, you can reach out to the following internal contacts:

  • [Name] [Role: Retool Admin / Support ]: [Contact Details]
  • [Name]: [Role: …]: [Contact Details]

You can further break this down into:

  • DevOps Team - maintaing the Retool infrastructure
  • Retool Admins - managing the Retool environment

For external support, you can contact Retool directly at:

  • Retool Support: email support@retool.com
  • Retool Deployed Engineer: Firstname LastName (email)
  • External Slack Channel: Link here

How to access Retool​

Retool is available in three different instances, each serving a specific purpose within our development lifecycle:

  1. Development (Dev) Instance: This instance is designated for development and testing purposes. It provides a sandbox environment for creating, debugging, and iterating on applications without impacting the production environment.
  2. Staging (Stage) Instance: The Stage instance serves as a pre-production environment for testing and showcasing applications before deploying them to production. It replicates the production setup closely, allowing comprehensive validation of the application's functionality.
  3. Production (Prod) Instance: The Prod instance represents the live production environment. It hosts the final versions of applications accessible to end-users. It is crucial to exercise caution and adhere to proper testing practices before deploying changes to this instance.

How to sign up for Retool​

You can access Retool and learn more about our specific internal processes here:

  • SSO / Login Credentials
  • Any VPN restrictions
  • Any other security measures or interal processes regarding access

Retool also has a build-in functionality to request access to the instance. We have enabled / disabled this functionality. You can learn more about this feature here.

Retool Upgrades​

The current Retool version is <VERSION_NUMBER_HERE>.

At regular intervals, our Retool instances undergo upgrades that introduce new features and bug fixes, enhancing its overall performance and capabilities. These upgrades typically occur once a month and may require a few minutes of downtime to implement the necessary changes.

Benefits of Upgrades:

  • New Features: Retool upgrades bring exciting new features and functionalities, empowering users to create more sophisticated and powerful applications.
  • Bug Fixes: Upgrading Retool ensures that any reported bugs or issues are addressed, improving the stability and reliability of the platform.

Next Upgrade: The upcoming Retool upgrade is scheduled for [date] at [time]. During this time, there may be a brief period of downtime as the upgrade is implemented.

It is important for all users to stay informed about these upgrades and their impact. Regularly checking for announcements regarding upcoming upgrades ensures that you can plan your work and take advantage of the latest enhancements. You can learn about the new Retool upgrades on their official release notes page here.