> ## Documentation Index
> Fetch the complete documentation index at: https://docs.oasm.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Brand name and logo

> Customize how your OASM instance is presented in the console with your own brand name and logo

The **Brand name and logo** settings let you customize how your OASM instance is presented across the console. You can set the instance name and upload a logo so that the product reflects your organization instead of the default OASM branding.

The page lives in the console's **Admin** area under **System → Brand name and logo** (`/admin/brand`).

> [!NOTE]
>
> Branding is an instance-wide setting, so only users with the platform **Admin** role can change it. The **Admin** entry appears in the user menu only for admins — see [Users and roles](/users-and-role#the-admin-area).

## Why branding matters

For many deployments, presenting the platform under your own identity is as important as the functionality itself:

* **Self-hosted deployments** — Operators often deploy OASM for an internal security team. Setting the name and logo makes the instance feel like part of the organization's tooling rather than an unconfigured default.
* **Multi-tenant instances** — When the same instance serves several teams or departments, distinct branding clarifies which instance a user is looking at and reduces confusion between environments.
* **White-label setups** — Managed security providers and consultancies can rebrand the console for their customers, presenting the platform under the provider's own identity.

Branding is configuration, not customization of the codebase — no rebuild or redeploy of the application is required to change it.

> **Self-hosted deployment**
>
> When you run OASM on your own infrastructure, the default branding identifies the instance as OASM. Setting your organization's name and logo makes the console immediately recognizable to your internal team and avoids confusion with any other instance you operate. See [Deployment](/deployment) for the hosting options.

> **Multi-tenant instance**
>
> If the same deployment serves multiple teams, environments, or customer accounts, distinct branding per instance helps members tell which environment they are signed into at a glance — reducing the risk of acting on the wrong tenant.

> **White-label offering**
>
> Managed security providers and consultancies can present the platform under their own identity. Members and customers see your name and logo in the console chrome and on the login screen, while the underlying workspace and security data remain fully functional.

## Update your branding

**1. Open the Admin area**

Open the user menu at the bottom of the sidebar and choose **Admin**, then select **Brand name and logo** under **System**.

**2. Set the name**

Enter the platform name in the **Name** field (up to 100 characters).

**3. Upload a logo**

Under **Logo**, click **Upload** (or **Change** if a logo is already set) and pick an image. A square image works best; supported formats are **PNG, JPG, GIF, WEBP, and SVG**, up to **5 MB**. The selected file is listed as *"not saved yet"* until you save — click **Discard** to drop it.

**4. Check the preview**

The **Preview** section shows how the name and logo will look in the sidebar before you save.

**5. Save**

Click **Save changes** to apply the branding, or **Cancel** to revert unsaved edits.

> [!NOTE]
>
> Changes take effect immediately after saving. There is no restart or redeploy required — branding is applied from the console settings on the next load of the interface.

### Before you have uploaded a logo

If no custom logo is set, the page shows **Using the default logo** under the logo placeholder. You can save a name without a logo and add the logo later using the same page.

## Where your branding appears

Once saved, the name and logo appear across the console — in the sidebar, on the login screen, and in the browser tab.

Because branding applies to the whole console, choose a name and logo that are recognizable at small sizes — the logo in particular is shown at a small scale in the navigation.

> **What about the login screen?**
>
> The login screen uses the same branding as the rest of the console. When your members sign in, they see your name and logo rather than the default OASM branding — useful for making self-hosted or managed instances feel like part of your own tooling.

## Preparing your logo

A little preparation goes a long way, because the logo is shown at small sizes in the navigation and browser tab:

* Use a **high-resolution** source image so it stays sharp when scaled down.
* Prefer a **transparent background** (PNG or WEBP) so the logo sits cleanly on any console theme.
* Keep the design **simple and legible** at small sizes — avoid fine detail or thin text that blurs.
* Check that the logo reads well on **both light and dark** themes.

| Format | Transparency | Best for |
| - | - | - |
| **PNG** | Yes | Logos with a transparent background (recommended) |
| **WEBP** | Yes | Logos with transparency at good compression |
| **GIF** | Yes (1-bit) | Simple graphics and small logos |
| **JPG** | No | Photos and images without transparency |
| **SVG** | Yes | Vector logos that stay sharp at any size |

> [!NOTE]
>
> Recommended workflow: export your logo as a transparent **PNG** (or **WEBP**), at a size that stays readable at the small navigation scale, and verify it against both light and dark themes before uploading.

## Updating or removing branding later

Branding is not permanent — you can change it any time from the same page:

* **Change the name**: edit the **Name** field and click **Save changes**.
* **Replace the logo**: click **Change**, select a new image, then **Save changes**.
* **Remove the logo**: click **Remove** and confirm. The platform falls back to the default logo right away — no save is needed — and the page shows **Using the default logo** until you upload a new one.

> [!NOTE]
>
> Branding changes apply to the whole console immediately after saving. No redeploy or restart is required.

## Branding in context

The **Brand name and logo** page is part of the platform-wide **Admin** area, not of any single workspace. It is a presentation layer on top of the platform:

* **Workspace settings** (under **Settings**) control the functional configuration of each workspace — see [Workspace](/workspace).
* **Deployment** determines where your instance runs, which is what most instances want to brand — see [Deployment](/deployment).
* Branding itself is independent of your scan targets, assets, and findings; it only changes how the console looks.

This separation matters for **multi-tenant** and **white-label** scenarios: you can present the same platform under a different identity per customer or team without changing the underlying workspace configuration.

> **Example: white-labeling for a customer**
>
> A managed security provider deploys OASM for a customer and wants the console to look like part of the customer's own stack. An admin opens **Admin → Brand name and logo**, sets the **Name** to the customer's product name, uploads the customer's logo, and clicks **Save changes**. From then on, the customer's team sees that name and logo in the console chrome, in the navigation, and on the login screen — with no code changes and no impact on the underlying workspace, targets, or findings.

## Troubleshooting

> **The logo does not upload — file too large**
>
> Logos are limited to **5 MB**. Compress or re-export the image at a smaller size, then try again. Most modern image editors can export a web-optimized PNG or WEBP well under that limit.

> **The logo is rejected — unsupported format**
>
> Only **PNG, JPG, GIF, WEBP, and SVG** are accepted. Re-export the image in one of these formats (for example, convert a BMP or TIFF to PNG) and upload it again.

> **I can't find the Brand name and logo page**
>
> The page moved from **Settings** to the **Admin** area. It is only visible to users with the platform **Admin** role: open the user menu, choose **Admin**, then **Brand name and logo**. Non-admins who open `/admin/brand` directly are redirected to the dashboard.

> **My logo changes are not showing up**
>
> The browser may be serving a cached version of the console. Do a hard refresh (for example Ctrl+Shift+R on Windows/Linux, Cmd+Shift+R on macOS) to load the updated branding.

> **The logo looks blurry or pixelated**
>
> The console scales the logo down for the navigation and browser tab. Re-export the logo from a higher-resolution source and use an SVG or a transparent PNG/WEBP for the sharpest result.

> **Can I use a logo without changing the name?**
>
> Yes. The **Name** field and the **Logo** upload are independent. Save the logo by itself, or the name by itself, in any combination.

> **Does branding affect other workspace members?**
>
> Branding is a console-wide setting: the name and logo apply to the whole instance for all members. It is separate from per-user settings such as profile details and permissions.

> **Will branding be removed on upgrade?**
>
> No. Branding is stored as part of the console settings, so it survives application upgrades and restarts. You only need to re-upload a logo if the instance was reset or redeployed from a clean state.

## Related pages

> **[Users and roles](/users-and-role)**
>
> The Admin area and the platform Admin role required to change branding

> **[Workspace](/workspace)**
>
> Manage workspace-level settings and configuration

> **[Deployment](/deployment)**
>
> Self-hosted deployment options where custom branding matters most


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.