LogoLogo
Getting StartedDevelopersDeployment GuideGet Help
  • Quick Links
  • Welcome to Form.io
    • Getting Started With Form.io
    • Launch a Form
    • Overview of Form.io
  • Developer Tool Ecosystem
    • PDF Solution
    • Enterprise Form Builder
    • Form View Pro
    • The Security Module
    • Accessibility Compliance Module
    • Developer License
    • SQL Connector - Deprecated
    • Integration Libraries
    • Form.io CLI Tool
  • User Guide
    • Introduction
    • Form.io Developer Portal
    • Teams
    • Projects
      • Project UI
      • Project Settings
      • Stages
      • Multi-Tenancy
    • Resources
      • ResourceJS
    • Forms
      • Form Creation
      • Form Types
      • PDF Forms
      • Embedding a Form
      • Form Revisions
      • Form Settings
    • Form Building
      • Form Builder UI
      • Form Components
        • Component Settings
        • Basic Components
          • Resource as Select Component Data Source
        • Advanced Components
        • Layout Components
        • Data Components
        • Premium Components
          • Nested Forms
        • Custom Components
      • Logic & Conditions
      • Existing Resource Fields
      • Actions
    • Submissions
      • Accessing Submissions
      • Importing Submissions
    • Form.io eSignature - Coming Soon
    • Form.io Reporting Module
    • PDF Template Designer
    • Form View Pro
    • Form Manager
    • Enterprise Form Builder Module
      • Installation
      • User Guide
  • Developer Guide
    • Introduction
      • Application Development
      • API Documentation
    • Form Development
      • Form Renderer
      • Form Builder
      • Form Embedding
      • Form Evaluations
      • Form Templates
      • Custom Components
      • Translations
    • JavaScript Development
      • JavaScript SDK
      • JavaScript Frameworks
      • JavaScript Utilities
    • Authentication and Authorization
      • SAML
      • OAuth
      • LDAP
      • Resource Based Authentication
      • Email Authentication
      • Two-Factor Authentication
    • Roles and Permissions
      • Field Match-Based Access
      • Field-Based Resource Access
      • Group Permissions
    • Integrations
      • Email Integrations
      • File Storage
      • Google Developer Console
      • eSign Integrations
      • Relational Databases
    • Modules
    • Fetch Plugin API
    • CSS Frameworks
    • Offline Mode
    • Audit Logging
  • Deployments
    • Self-Hosted Deployment
      • Local Deployment
        • Local File Storage
      • Kubernetes
      • Cloud Deployment
        • AWS Deployment
          • AWS Lambda
          • Form.io/AWS Elastic Beanstalk End-To-End Encrypted Deployment
        • Azure Deployment
          • Azure App Service
            • Azure MSSQL Connector - Deprecated
          • Azure Virtual Machine
          • Azure Kubernetes Service
          • Set up the DB
        • GCP Deployment
          • GCP Cloud Run
      • On-Premise Deployment
      • Enterprise Server
      • PDF Server
    • Deployment Configurations
      • DNS Configuration
      • Load Balancer Configuration
    • Licenses
      • License Management
      • Library Licenses
    • Portal Base Project
      • Portal SSO
      • Portal Translations
    • Maintenance and Migration
      • Changes to Premium Libraries
  • FAQ
    • FAQ
    • Tutorials & Workflows
      • Password Reset
      • Dynamic Select Filtering
      • Approval Workflow
      • SSO Email Token
      • Embedding A Video
      • Data Source Validation
      • Select Data Source Options
      • Nested Form Workflows
        • Nested Wizard Forms
      • Save as Draft
      • Role-Based Conditions
      • Custom Component
      • Dynamic Radio and Select Box Values
      • Override CKEDITOR
    • Errors
    • Examples
    • License Utilization Checks
  • Contact Us
Powered by GitBook
On this page

Was this helpful?

  1. Deployments

Portal Base Project

PreviousLibrary LicensesNextPortal SSO

Last updated 8 days ago

Was this helpful?

The Portal Base is an administrative project for your environment.

DO NOT build your forms for your application in the Portal Base project. Instead, go to the home page and create a new project.

The Portal Base project is a special project that is included with a and is used to control the Portal Application. Utilize this project to control the administrative user base that will authenticate into the environment, Teams to control project permissions, SSO environment, Portal Translations, and more.

This Project contains specific Forms and Resources to help manage your environment. The following section lists all Forms and Resources within this project and what administrative purpose they serve. The Portal Base Project is not counted towards the project limit for a Self Hosted License.

To reinstall the Portal Base Project, delete the project within the Database, and restart the environment container. This process will recreate the Portal Base Project within the environment

Simply deleting the Portal Base Project from the Developer Portal UI (rather than entirely from the DB as described above) and reinstalling it, will inadvertently consume a Project allocation within the license scope.

Portal Base Forms and Resources

The Forms and Resources that are in the Portal Base project govern the Developer Portal Application and its functionality. Below is a list of these Forms and Resources.

User Resource

By default, Users created within this Resource will be assigned the Authenticated role which allows these users to create Projects, having full permission rights to read, modify, and delete the projects these users own (created).

Admin Resource

Use the USER resource to assign permissions to projects, by adding the USER to a team that has whatever Team Permissions are appropriate for the team.

The Admin Resource can be leveraged to manually create new Admin accounts for the Developer Portal Application. Make submissions against this Resource to create your Form.io Developer Portal Admins.

If you have lost access to your Form.io admin portal or need to reset the admin credentials, follow the documentation link below to regain access.

By default, Admins created within this Resource will be assigned the Administrator role which grants these users full permission rights to view all projects created within the Form.io Developer Portal. This is not a substitution for Teams. To grant access to projects, use the USER Resource, add those Users to Teams, and assign the Teams to a project with the appropriate access level desired. More described below:

Team and Team Member Resource

Use these Resources to create or manage the Team Members and their associated Teams. Team Member emails are associated with accounts created within the User Resource or emails from an integrated SSO provider.

SSO_TEAMS=true

Language Resource

PDF Resource

A log of all of the PDFs uploaded to the Environment.

Two-Factor Authentication Forms

User Login Form

The authentication form for the environment

User Registration Form

By default, the Registration Form is disabled for deployed projects as User creation is typically done by using the User Resource. To allow for User Registration on the authentication page, simply add an email and password field to the Registration form.

The User Resource can be leveraged to manually create new User accounts for the Developer Portal Application. Make submissions against this Resource to create your Form.io Developer Portal users. These Users can then use the submitted credentials to log into the Developer Portal Application. Alternatively, the Form.io Developer Portal can be configured to support SSO .

Use the following to remove the User permission for creating projects. ONLY_PRIMARY_WRITE_ACCESS = true Available in API Server version 8.0.0 or later only.

formio-enterprise:8.0.0 and later: When logged in as an Admin, are granted to all projects. Access Permissions allow only for the ability to see the Project within the home page. No access is given to read or write anything within that project. Admin users have Access permissions to all projects within the environment, providing visibility and access to the project on the Portal home page. However, Project-level Read, Write, or Admin permissions are not granted. Create a if additional Project permissions are needed for Admin Users.

When creating SSO Teams, ensure you have the correct set

Add and manage inside the environment. Users can change the Portal Language by clicking the Language dropdown in the Portal header and selecting a Language.

Forms that facilitate the environment process.

as described here
Portal Translations
Two-Factor Authentication
Self-Hosted Environment
Click here for more information on the Registration Form setup
Access permissions
Team
environment variable
Environment Variable
Reset Admin Password for Deployed Portal