Sufia Hub User Guide

A clear workflow for using Sufia Hub to create and manage your Sufia workspace.

1. What This Guide Is For

This guide explains how to use Sufia Hub to create, open, manage, and support your Sufia workspace.

Sufia Hub is not the full SØAD Framework manual. For detailed SØAD architecture, transactions, SOADMIN tools, database usage, built-in AI features, and development examples, read the official SØAD documentation:

Sufia Documentation

2. What Sufia Hub Does

Sufia Hub prepares a ready-to-use workspace for you. It handles the setup work so you can focus on using SØAD.

Sufia Hub can:

• Register your workspace.
• Create your workspace URL.
• Prepare the SØAD runtime and database.
• Install a trial license.
• Create your user login.
• Open your Workspace Dashboard.
• Let you manage environment variables.
• Let you restart or stop your workspace when available.
• Help you request support.

3. Workspace Workflow Overview

The normal workflow is:

1. Register a workspace in Sufia Hub.
2. Wait while Sufia Hub prepares the workspace.
3. Open the Workspace Dashboard.
4. Confirm the workspace is ready.
5. Open your Sufia application or SOADMIN.
6. Log in using the email and password from registration.
7. Use SOADMIN or your preferred Sufia development workflow.
8. Return to Sufia Hub when you need to manage workspace settings.

For learning how to build in SØAD, use the official docs:

Sufia Documentation

4. Before You Register

Prepare this information:

The code name becomes part of your workspace URL. Use lowercase letters, numbers, and underscores. Avoid spaces and symbols.

Example:

customer_portal

5. Register A Workspace

1. Open Sufia Hub in your browser.
2. Click Try Sufia Now or open the registration page.
3. Fill in the registration form.
4. Check that your email is correct.
5. Choose a secure password.
6. Submit the form.

Sufia Hub will validate your details and start preparing the workspace.

6. What Happens During Setup

During setup, Sufia Hub automatically:

1. Checks your code name and email.
2. Creates a trial license.
3. Creates your workspace environment.
4. Starts the SØAD runtime and database.
5. Creates your workspace URL.
6. Creates your user account.
7. Opens your Workspace Dashboard.

Setup can take a short time. If you see a loading screen, wait until it completes.

7. Workspace URL

Your workspace URL uses this format:

https://sh-<code-name>.soad.app

Example:

https://sh-customer-portal.soad.app

Use this URL to access your Sufia workspace.

8. Workspace Dashboard

The Workspace Dashboard is your Sufia Hub control screen.

Use it to:

• Check workspace status.
• Open your Sufia application.
• Open SOADMIN.
• Manage environment variables.
• Restart SØAD when needed.
• Stop or resume the workspace if available.
• Request support.
• Delete the workspace.

9. Understand Workspace Status

If the workspace is not ready immediately after registration, wait a short while and refresh the dashboard.

10. Open SOADMIN

SOADMIN is the browser-based Sufia development environment.

To open SOADMIN:

1. Open the Workspace Dashboard.
2. Click Go to App, Host, or your workspace URL.
3. Open the SOADMIN login page.

SOADMIN URL format:

https://sh-<code-name>.soad.app/s0adm/t/uac/login

Example:

https://sh-customer-portal.soad.app/s0adm/t/uac/login

Use the same email and password you entered during Sufia Hub registration.

For details on using SOADMIN, transactions, database tools, file manager, logs, and built-in AI features, read:

Sufia Documentation

11. What To Do After First Login

After SOADMIN opens:

1. Confirm you can log in.
2. Confirm the page loads without error.
3. Explore the available SOADMIN tools.
4. Follow the official SØAD documentation for development steps.

Sufia Hub prepares the workspace. The official SØAD docs explain how to build applications inside it.

12. Manage Environment Variables

Environment variables are runtime settings for your workspace.

Use them for:

• API URLs.
• Integration settings.
• Feature flags.
• Public configuration values.

To update environment variables:

1. Open the Workspace Dashboard.
2. Open the manage or environment settings area.
3. Add or update the key and value.
4. Save the changes.
5. Wait for the workspace to redeploy or restart.
6. Test your Sufia application again.

Do not store highly sensitive secrets unless your organization has approved that workflow.

13. Restart SØAD

Use restart when your SØAD runtime is not responding or when a runtime setting needs to reload.

Restarting SØAD:

• Restarts the SØAD runtime.
• Does not delete your workspace.
• Does not remove your database.
• Does not remove your license.
• Does not delete application files.

After restart, wait for the status to become ready before testing.

14. Stop Or Resume Workspace

Some workspaces may allow stop, suspend, or resume.

Stop or suspend means the workspace is intentionally stopped and may not be accessible.

Resume starts the workspace again. After resume, wait until the status becomes ready before opening SOADMIN or testing the application.

If you do not see these controls, your account may not have that option.

15. Delete A Workspace

Delete only when you no longer need the workspace.

Deleting can:

• Mark the workspace as deleted.
• Remove the running workspace environment.
• Stop access to the workspace URL.
• Prevent normal login to that workspace.

Sufia Hub may ask you to confirm deletion by typing:

DELETE

Before deleting, save or export anything important.

16. License

Each new workspace receives a trial license.

If the license expires or you need a different license type, contact support.

17. Support Request

When requesting support, include:

• Workspace code name.
• Workspace URL.
• Your email address.
• What you were trying to do.
• What happened instead.
• Any error message shown.
• Approximate time the issue happened.

Clear information helps support respond faster.

18. Official SØAD Documentation

Use the official SØAD documentation when you need to learn:

• SØAD architecture.
• SOADMIN features.
• Transactions.
• Database tools.
• File manager.
• Server logs.
• Built-in AI features.
• SØAD CLI usage.
• Framework examples.

Official docs:

Sufia Documentation

19. Common Issues

Code name already used

Choose a different code name. Each workspace needs a unique code name.

Workspace is still starting

Wait a short while, then refresh the Workspace Dashboard.

SOADMIN login page does not open

Check that the workspace status is ready. Then open:

https://sh-<code-name>.soad.app/s0adm/t/uac/login

Cannot log in

Check that you are using the same email and password entered during registration. If available, use password reset. If it still fails, contact support.

Application is not responding

Check the workspace status. If the workspace is ready but the application still does not respond, try restarting Sufia. If the problem continues, contact support.

Environment variable change does not appear

After saving environment variables, wait for the redeploy or restart process to complete. Then refresh and test again.

I need to learn how to build in SØAD

Open the official SØAD documentation:

Sufia Documentation

20. Quick Start Checklist

1. Register your workspace.
2. Wait for setup to complete.
3. Open the Workspace Dashboard.
4. Confirm the workspace status is ready.
5. Open SOADMIN.
6. Log in with your registered email and password.
7. Use the official SØAD docs to learn development.
8. Return to Sufia Hub to manage workspace settings.
9. Contact support if you are blocked.