🛠️Deploying with Custom Plugins

This guide describes how to customize your Astral API Portal by writing your own plugins. In this example we will be creating our own API credential management plugin.

Please visit the Astral API Portal Launcher to configure and download your API Portal.

  1. Open a local development environment with tools including Git for source version control, and Node.js and npm to install and run the Deploy CLI locally.

  2. With the template repository, create an .env.local at the root of the project and provide any necessary environment variables.

  3. Next, run the development server:

npm run dev
# or
yarn dev

4. Open http://localhost:3000 with your browser to see the result. You can start customizing your API developer portal by modifying portal.config.js. Refresh your page to see changes.

5. For connecting your custom API Authentication, write an internal API to getTeam, createCredential, rotateCredential, and deleteCredentials

6. For User Management and Team Management, either create a free Auth0 account, and input the M2M credentials, or write a bespoke setup for your user/team configuration (login screen, hierarchy, etc.).

----

Example portal.config.jsto visual:

PreviousDeploying with Auth0NextSupport

Last updated