Skip to main content

One post tagged with "SSR"

View All Tags

Introducing Authentication and SSR Mode

· 3 min read
David Boyne
David Boyne
Founder of EventCatalog

Today we are excited to announce the release of the EventCatalog Authentication and EventCatalog SSR Mode. These new features are designed to help you get the most out of EventCatalog.

EventCatalog AuthenticationGet started with EventCatalog Authentication

Authentication​

EventCatalog now provides secure authentication to control access to your documentation. Whether you're a small team getting started or a large enterprise with complex identity requirements, EventCatalog's flexible authentication system grows with your needs.

On the initial release we support the following identity providers:

If we are missing your identity provider, please let us know and we will add support for it.

How it works​

EventCatalog uses industry-standard OpenID Connect (OIDC) and OAuth 2.0 protocols to integrate with your identity provider. Here's the authentication flow:

  1. User visits EventCatalog and attempts to access protected documentation (everything is protected by default)
  2. Redirects to your identity provider (GitHub, Google, Auth0, etc.)
  3. User authenticates with their existing credentials
  4. Provider confirms identity and sends user back to EventCatalog
  5. User gains access to your documentation and architecture

To get started with authentication, you can read our quick guide in our documentation here.

SSR Mode​

By default EventCatalog exports a static HTML site. This means you can deploy your application anywhere you want.

We have found for users with large catalogs, the build time can be slow, as every page is rendered and built.

We are excited to announce that EventCatalog now supports SSR mode (Server side rendering), this means you can use EventCatalog as a server-side rendered application. This is perfect for large catalogs, for users with slow deployment times and for users that are using EventCatalog features that require a server (e.g EventCatalog Chat, EventCatalog Authentication)

Rather than building the entire catalog into HTML files, EventCatalog will render the pages on the fly (using server-side rendering).

To enable SSR mode, you need to update your eventcatalog.config.js file to use SSR mode.

eventcatalog.config.js
export default {
  // defaults to static
  output: 'server', 
}

This tells EventCatalog to build the application as a server-side rendered application.

You can then deploy your application to a server that can run Node.js.

If you want to learn more about how to host your SSR applications, you can read our quick guide in our documentation here.

Summary​

EventCatalog Authentication and SSR Mode are designed to help you get the most out of EventCatalog.

EventCatalog Authentication provides secure authentication to control access to your event-driven architecture documentation.

EventCatalog SSR Mode is perfect for large catalogs, for users with slow deployment times and for users that are using EventCatalog features that require a server (e.g EventCatalog Chat, Authentication)

What's next?​

We will continue to add more support for more identity providers, and explore role based access control (RBAC) for EventCatalog.

We will also be exploring bringing your own middleware to EventCatalog, this will let you add your own authentication and authorization logic to EventCatalog.

If you have any questions, feel free to join over 1,100 EventCatalog users on Discord, we are happy to help you get started.