1. Agree to the Terms of Service

Please note that Dogen is in its alpha testing phase and is provided "as is" without any warranties. Use cautiously, back up your data regularly, and review your Firebase billing to avoid unexpected charges.

By proceeding with the installation, you agree to our Terms of Service and Privacy Policy.

2. Enable the Blaze Billing Plan

To use Firebase Extensions, the Blaze plan must be enabled for your Firebase project. Note that this is a Firebase requirement, not a Dogen-specific one. While enabling Blaze allows the extension to function, you will still benefit from the Free tier benefits.

• Go to the Firebase console and click on the cog next to Project Overview.
• Select Usage and billing from the dropdown menu.
• Click on the Details & settings tab.
• Enable the Blaze plan.

3. Create a Firestore Database

Set up a Firestore database in your Firebase project. Learn more.

4. Enable Firebase Authentication

Enable Firebase Authentication in your project. Learn more.

• Enable the Email/Password sign-in method.
• Create a new user account if you don't have one, which will be used as the Admin User Email in the extension configuration.

5. Create a New Web App

• In the Firebase console, click on Project Settings.
• Under Your apps, click Add app.
• Register a new Web App for the Dogen AP client and copy the Firebase configuration object.
• Save the configuration object temporarily as you will need it later.

6. Install the Dogen Application Platform Extension

Follow the link below to install the extension. Select your target project and review the extension's source code and details.

On the Extension Configuration page, provide:

• A registration email address to register your project under. This must be a valid email so you can confirm your registration.
• A Dogen invitation code, if you have one, or leave it blank to join the waitlist.
• A Dogen API key, if you have one, or leave it blank.
• A Google Cloud Location where the extension's cloud functions will be installed.
• An Admin User Email from step #4. This must match an existing Auth user in your project.
• The Firebase application config values from step #5.

After finalizing the installation, you'll receive an email with further instructions. If you've encountered an error, please uninstall the extension and try installing it again. If this fails, contact us for assistance.

API keys and invitation codes are project-specific. If using multiple Firebase projects, each will require a separate extension installation, API key, and invitation code (or waitlist entry).

7. Update Your Firestore Rules

Dogen uses Role-Based Access Control (RBAC) to manage user access by utilizing Firebase Authentication user tokens. During the installation process, the Dogen extension will automatically add an "admin" role to the dogenRoles array in the authenticated user's token.

To enable these admin users to access your data, you need to configure a security rule in your Firebase project. If you have existing application code that modifies user tokens, ensure that your custom code does not remove or overwrite the dogenRoles key in the user's token.

Below is an example security rule that grants global access to admin users. If you have data that you do not wish to manage through Dogen, you can create more granular rules to restrict access as needed.

			
rules_version = '2';
service cloud.firestore {
	function isAuthorized(role) {
		return request.auth != null && ('admin' in request.auth.token.dogenRoles || role in request.auth.token.dogenRoles);
	}
	match /databases/{database}/documents {
		match /{document=**} {
			allow read, write: if isAuthorized('admin');
		}
	}
}
		

Note: Currently, Dogen AP is primarily designed for admin users. Future updates will support more capabilities for non admin roles.