# White Label ## What is White Label Simply put, the white label option allows you to make a 1:1 copy of the Datacake platform and place it on your desired domain, upload a custom logo and browser icon, and hook up a personal E-Mail for sign-up, password reset and notifications. You can see your white label as a mask on top of Datacake. Configure the areas that are important for your customers and hide the ones that aren't. ### What does it include? The functionality of the platform under the white label is completely the same as Datacake. Additionally you can configure the access your users have to specific areas on the platform as well as allow or disallow certain capabilities they have across te platform., There are several options available to you, which are further described in the section [Capabilities](#capabilities). More details about our white label service can be found here: {% embed url="" %} ## Requirements To set up your white-label site, you need to be in possession of a domain name and have access to its DNS server configuration. You also need an active email address from which you want the portal to send emails. * Domain Name * Active E-Mail Address * Access to DNS Server Configuration ## Getting started To get started with your first white label site, make sure you have the sufficient permissions (Billing and White Label) on the workspace you want to manage your white label solution from. Take into consideration that all configurations and cancelation will only be available on the workspace you create the white label from, so choose the workspace wisely. {% hint style="success" %} While white-label sites are not tied to a workspace, the billing information from the currently active workspace is being used to create the site. This means that the white label solution will be charged on the workspace's invoice you create it from. {% endhint %} Click on "White Label" from the left sidebar navigation and select "Add white label site" on the top right corner. You will see a modal outlining the benefits of a white label site. Click "Get started" and you will see a form asking for:
### **Name** This is the name of your white-label site. It is used as the page title as well as in all email communication. ### Domain The domain can either be a top level domain (e.g. `eggtregg.com`) or a subdomain (e.g. `iot.eggtregg.com`). {% hint style="info" %} After the creation of the white label site, you will see the necessary DNS records you have to create. {% endhint %} ### Email "From" Your white label site will send transactional emails such as signup confirmation or device alerts from this email address. {% hint style="warning" %} This has to be an active email address since our email service **Postmark** will send a confirmation email to this address in the next step. {% endhint %} ### Email "From" name This is the display name of the email's sender. It can for example be the name of your site or the name of your company. When you're done entering the information, click "Next". On the following screen, you will find the payment details such as the payment method and billing address. When done, click "Buy white label site". ## Setup & Configuration After you have created your white label site, you can do further adjustments such as uploading a logo and favicon, under the General tab. Always remember to Save your changes. ## Domain ### DNS setup Under the Domain tab you will be able to see the domain you selected to be used with your white label site. You will have to configure your domain's DNS Server to be able to use it. There are two options for pointing a root domain to your white label site. * **Point ANAME or ALIAS record to whitelabel.datacake.co**: Use a DNS provider that supports ANAME or ALIAS records. * **Point A record to 164.90.242.26**: Create an A record for your domain pointing to our load balancer's IP address. Once done this, allow up to 24 hours for the changes to propagate. If this does not work after 24 hours, please contact . {% hint style="warning" %} Please note that DNS propagations can take up to 24 hours. {% endhint %} ## E-Mail In order to send emails from your own domain you need to verify the setup email by clicking the link on the confirmation email your received from our service provider **Postmark.** ## Appearance ### Branding The Branding section allows you to define the visual identity of your white label site. You can set a custom name, which will be displayed as the page title and used in email communications, ensuring a consistent experience for your users. Additionally, you can upload a logo that appears on the login screen and serves as a fallback for workspaces without their own logo. A favicon can also be configured to personalise the browser tab, helping reinforce your brand presence across the platform.
### Authentication Screen The Authentication Screen settings let you customize the appearance of your login and sign-up pages. You can choose from two different layout options, card or split screen, to match your branding style and user experience preferences. Furthermore, you can upload a custom image that will be displayed on the authentication screen, allowing you to create a more engaging and professional first impression for your users.
### Banner You can configure a banner on your white label site. Select the size of the banner, the text and background colours. You can add links as a menu item by adding a title and an URL. {% hint style="info" %} Don't forget to press on "+" to add it to the list and don't forget to save the changes! {% endhint %}
Setup a logo as well and that is it. Refresh your white label site to see the changes reflected. ## Connectivity ### Domain & Email The Domain & Email section allows you to consult the custom domain your white label site is served from, as well as the email address used for outgoing communications. {% hint style="warning" %} Once you create your white label site, you cannot change the (sub-) domain or email you chose. In case you need to make any corrections, you will have to contact us to {% endhint %} You can connect your own domain by updating your DNS settings, and once configured correctly, the platform will verify and confirm the setup. For email sending, you can define a sender address that will be used for system notifications and user communication. To ensure reliable delivery and improve inbox placement, it is recommended to authenticate your domain by adding DKIM and Return-Path DNS records. Once verified, your emails will be sent using your branded domain, providing a more professional and trustworthy experience for your users.
### API You will be able to use our GraphQL API to make queries and/or mutations, ingest or export data out of the platform, using your white label. This means that you get your own proxy and MQTT broker name with your branding.
## Devices ### Device Types You can choose what kind of devices your white label users are able to add on to the white label site. This setting can be adjusted on the Device Types tab
#### Pin Code This option is set by default and allows the users of your white label site to add new devices to his workspace via pin code. You must first create devices on one of your workspaces on Datacake (or your white label site) and set an individual pin code on that device. Read more about how to do that here: {% content-ref url="/pages/-M-JQQctuXfCo26MgDFn" %} [Claiming](/device/claiming.md) {% endcontent-ref %} You can then send these devices to your customer and include the pin code and serial number. Your customer can then use this information to register the device on their desired workspace. #### LoRaWAN If you activate this option the users of your white label site will see the same LoRaWAN Section (which includes templates, network servers, and device plans) that you see when you add a device on the Datacake Platform. {% content-ref url="/pages/-M6ACJSn7S8bUWugprHz" %} [LoRaWAN](/lorawan/get-started.md) {% endcontent-ref %} #### API By activating this option, the users of your white label site can add new API devices that will receive their measurements over API or MQTT. More information about receiving measurements via API here: {% content-ref url="/pages/-M6nAh4XKJHvdXVq7N0F" %} [Record Measurements via API](/api/record-measurements-via-api.md) {% endcontent-ref %} ### General Configuration You have the option to enable or disable access to different areas of the platform on your white label site. Under General Configuration, you can hide aspects of the General Configuration of your devices.
The above areas are to be found inside of any of your devices, under Configuration/General. If you chose to disable any of them, they won't be available for your white label users.
### Device Tabs You can chose to hide certain tabs found on your devices.
If you chose to hide them, the following tabs/options won't appear on your white label site:
If you chose to "Hide product configuration", the following part will be hidden:
If you select to hide "devices overview" or "device map", the following options will be removed:
### Features & Integrations The Features & Integrations section allows you to enable or disable optional platform capabilities for users of your white label site. This includes integrations such as Cake Red (Datacake’s managed Node-RED service) and MQTT, as well as workspace-level integrations that let users connect external services like webhooks, LoRaWAN network servers, or custom MQTT brokers. By controlling these options, you can tailor the platform to match your specific use case and limit access to only the features your users need.
In addition, you can configure monitoring and data management features such as gateway monitoring, reports, exports, and zones. These options determine whether users can receive connectivity alerts, generate reports, export data, or organize devices into zones. This level of control helps you simplify the user experience while still providing access to advanced functionality where required. The Rules section further allows you to manage automation capabilities within your white label environment. You can enable legacy rules, the Rule Engine, and rule notifications independently, giving you flexibility in how users interact with automation features. This ensures that you can support both simple notification use cases and more complex automation workflows, depending on your project requirements. ### Sign-up & Login * **Allow Sign-up:** Your users are able to create a user and account for the platform. * **Restrict Login**: If enabled, users are only able to login to your white label site, not app.datacake.de. This is enabled by default for new white label sites. * **Allow Adding Workspace:** Your users are allowed to create new workspaces on the white label site. * **Auto-assign signups to this organization:** If enabled, users that sign up on your white label site will have their workspace placed under your organization, sharing its billing, instead of getting a new organization of their own. This is useful when you want to manage and pay for all of your customers' usage centrally rather than having each user bill themselves. * **Billing:** If enabled, your users will be able to see the Billing section on the left-side menu. {% hint style="info" %} With **Auto-assign signups to this organization** enabled, new sign-ups draw from your organization's existing quota. Make sure your plan provides enough quota for the workspaces and devices your users will create. {% endhint %} ### Legal
When your users log in to your white label, the Terms of Service and Privacy Policy are displayed. These are still set to the Datacake Terms by default after the creation of the white label. With the following mask you can add a link to your own terms. ### Users The Users section, available in **Enterprise packages**, provides an overview of all users within your white label environment. It displays key information such as user email addresses, names, the date they joined the platform, and their last activity. This allows administrators to easily monitor user access, track engagement, and manage their user base efficiently. The simplified view ensures you have full visibility over who is using your platform without unnecessary complexity. ### Audit Log The Audit Log, also available in **Enterprise packages**, offers detailed tracking of user and system activity across your white label site. It records important events such as: * logins, * password changes, * user invitations or removals, * device and * product configuration changes, * permission updates, and * downlink actions You can filter events by including or excluding specific activity types, making it easier to focus on relevant information. Additionally, the audit log can be exported as an Excel or CSV file, enabling further analysis, reporting, or compliance documentation. ## Multi-Tenancy Another important fact is that the Multi-Tenancy Feature of Datacake is also available on white label sites. This means that you or your users on your white label site can sign themselves up, register devices and create separate tenants (workspaces). This also means that you still get: * The workspace quota available in your plan * Unlimited Members inside of those workspaces {% hint style="success" %} This is a huge difference to other solutions out there as mostly all of them only allow white label to take place on a single tenant only! {% endhint %} ## Billing By letting your users add LoRaWAN or API Devices on your white label site, they do this in the same way that you do this on Datacake. This means that your end users have 5 devices free but need to pick a plan after they have used up all free devices. Picking a plan requires your end users to provide a credit card on your white label site in order to create more than two free devices. In case you don't want your users to use the billing system, we highly recommend you to use the pin code system, in which you add and configure your devices into your master workspace and your users create a copy of it in their own workspace. This way, your user pays you and you manage the platform billing yourself. ## Canceling your white label site If you no longer need your white label site, you can click the "Cancel White Label site" button and cancel your subscription any time. ### Reactivation When a white label site is canceled, it will remain accessible for the current billing cycle as stated in the confirmation message. {% hint style="success" %} During this period, you are able to reactivate the subscription to prevent a final deletion of the white label site. {% endhint %} ## Rules If a [rule](/portal/rule-engine.md) is created on a white label site, when the rule gets triggered, it will send out the notification under the white label's configuration. This means that if you create a rule that sends our emails, they will be sent through the email you configured on your white label site. If you are on app.datacake.de, create a rule and have the permissions on a workspace, you have the option to choose the branding for this rule in the editor. ![On app.datacake.de, you can choose the branding for emails sent by a rule.](/files/-MJlymQdDh3OT0PXiDr8) ## Best Practices ### User Accounts As a Datacake white label site is just a proxy for branding the platform and optionally taking out various elements, your user accounts that work on `app.datacake.de` also work on your white label site. This means that you will be able to see all workspaces you have been added as a member also on your white label site. ### Administration We recommend that you use the `app.datacake.de` portal for the administration and management of your devices, as well as your white label site. ### Customers Onboard your customers on your white label site. This way they will get the email invitations, as well as any notifications with your branding and through your setup email. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.datacake.de/portal/white-label.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.