Skip to main content

Guides for Managing and Operating Portal

Explore our comprehensive guides designed to help you effectively manage, operate, and update your Portal installation.

Managing Environment Variables and Secrets​

Learn the best practices for handling frontend and secret environment variables in Portal, including the use of prefixes and visibility validation.

  • Environment Variable Types: Understand the difference between frontend and secret environment variables.
  • Substitution and Validation: How to correctly substitute and validate environment variables in Portal configurations.
  • Required Variables: A list of all required environment variables for Portal to function correctly.

Learn more about environment variables and secrets

Enable Recovery Mode​

A step-by-step guide to enabling recovery mode in Portal using environment variables to secure access during critical recovery operations.

  • Activating Recovery Mode: Detailed instructions to set up and enable the /root/login path for emergency access.

Learn more about recovery mode

Running Portal Locally​

Get started with running Portal in a local environment, ideal for development and testing before production deployment.

  • Prerequisites: What you need before you start.
  • Local Setup with Docker Compose: Instructions to configure and run Portal using Docker Compose.

Learn more about running Portal locally

Updating Portal​

Ensure your Portal instance is up-to-date with the latest features and security updates.

  • Overview of Updates: The importance and benefits of keeping Portal updated.
  • Step-by-Step Update Instructions: How to update to the latest version.

Learn more about updating Portal

Transitioning from Private to Limited Beta​

Guidance on transitioning from the Private Beta version of Portal to the new Limited Beta available on Docker Hub.

  • Image Replacement: Instructions to switch from the private registry to the public one.
  • Versioning Changes: Understanding the new versioning format for the public Portal images.
  • Adjustments Required: Additional changes needed when switching to the public version.

Learn more about transitioning to limited beta