Configuring

This page describes the configuration settings for the Tenant SDK. These are saved as AppSettings entries in the web.config file or as Application settings on the App Service in Azure.

Custom domain

If you don’t need to configure a custom domain for the deployed Weavy installations or if you are evaluating Weavy, you can leave the value for CustomDomain blank. The site will be then be accessible on the standard https://*.azurewebsites.net url. Also, you will not need to configure the SSL settings, as these are only needed if you use a custom domain. You can always change the configuration in a later stage and configure the deployed sites to use a custom domain. But it will require some manual work.

API Settings

Settings for the Tenant API. The API enables you to programatically perform tasks that you would otherwise need to perform using the Dashboard (e.g. create sites, backup sites, manage builds etc.).

Name Description
ApiSecret A secret string used when authenticating against the Tenant API. Choose something complex.
ApiCertificateName The name of the .pfx certificate used for creating signing certificats. i.e. wmp-certificate.pfx
ApiCertificatePassword The password that goes with the certificate.

Azure AD Authentication Settings

Configure these settings if you are using Azure AD when authenticating against the Dashboard. If you are using Google Identity Platform, these settings should be left blank.

Name Description
AADInstance Should be https://login.microsoftonline.com/{0} for the global Azure AD.
AADClientId The Application ID of your Azure AD app.
AADTenant The name of your Azure AD tenant (e.g. domain.com or name.onmicrosoft.com).

Azure Configuration Settings

Configure Azure related settings.

Name Description
AzureSubscriptionID The ID of the Azure subscription where resources should be created and maintained.
AppServiceTier Defines, together with the AppServicePlanSize, the tier and size of the App Service Plan. Recommended: PremiumV2.
AppServiceSize Defines, together with the AppServicePlanTier, the tier and size of the App Service Plan. Recommended: P1v2, P2v2 or P3v2.
DefaultRegion The Azure location to deploy to (see possible locations).
MaxSitesPerHostingPlan A number indicating how many apps to add per app service plan before creating an additional one. (default: 400).
TenantDomain The tenant domain of your Azure AD (e.g. *.onmicrosoft.com). Visible in Azure Portal from the overview blade of your Azure Active directory.

Azure Service Principal Settings

Settings for the service principal used to access Azure resources.

Name Description
SaTenantId The tenant id of the Azure AD.
SaClientId The client id of the Azure AD application serving as service principal.
SaClientSecret The client secret of the Azure AD application serving as service principal.

Azure SQL Settings

Settings for Azure SQL.

Name Description
DatabaseAdminUsername The admin username to set when new Azure SQL Servers are created.
DatabaseAdminPassword The admin password to set when new Azure SQL Servers are created. Make sure you select a valid password.
SqlDatabaseEdition Defines, together with the SqlDatabaseServiceObjective the edition and service objective (DTU) of the SQL databases that are created.
List of possible values (not all are applicable). Recommended: Standard.
SqlDatabaseServiceObjective Defines, together with the SqlDatabaseEdition the edition and service objective (DTU) of the SQL databases that are created.
List of possible values (not all are applicable). Recommended: S1 or better.

Google Identity Authentication Settings

Configure these settings if you are using Google Identity for authentication in the Portal. If you are using Azure AD authentication, these settings should be left blank.

Name Description
GoogleAuthAllowedDomains The email domains that are allowed to login to the Portal.
Separate multiple domains with comma (e.g. "company.com" or "company.com,weavy.com").
GoogleAuthClientID The client id of the Google OAuth App.
GoogleAuthClientSecret The client secret of the Google OAuth App.

Misc Settings

Some miscellaneous settings.

Name Description
CustomDomain The name of the custom domain you have configured. Leaving this blank will result in all sites being created under the azurewebsites.net domain (e.g. {uniquename}.azurewebsites.net).
ApplicationUrl Enter the full url for the portal (e.g. https://portal.domain.com)
DefaultThemeColor The default theme color to use when deploying new Weavy installations.
ReservedHostnames A list of subdomains separated with comma (,) that are reserved and should not be used.
Example: if the custom domain is company.com and you are already using info.company.com and file.company.com internally, the value should be "info,file" to prevent these being used when creating Weavy installations
PrefixForResources A string that the Portal will prepend to all Azure resources it creates during the deployment of sites. This is required to minimize naming conflicts with other resources in Azure. 16 characters maximum, the prefix must be entered in lowercase and end with - (e.g. prefix-)
NotifyEmail The email address where you want to recieve notifications from the portal.
UseBlobStorage Set to 1 to configure new Weavy Tenants to use Azure blob storage to store files or set to 0 to store the files in the database. (exists since version 5.0.0)

Notification Hub Settings

Configure the hub settings if you are using the mobile apps (iOS/Android), otherwise leave blank.

Name Description
NotificationHubConnection The connection string for the notification hub.
NotificationHubPath The notification hub path.
MessengerNotificationHubConnection The connection string for the Messenger notification hub.
MessengerNotificationHubPath The messenger notification hub path.

SMTP and Mail Settings

Configure the SMTP and email settings that deployed Weavy installations should use.

Name Description
SmtpServer The server to use.
SmtpPort The port to use.
SmtpUserName The username to use.
SmtpPassword The password to use.
SmtpSSL If deployed Weavy installations should use SSL/TLS when connecting to the SMTP server (true/false or 1/0).
SmtpSender The from address to use when sending emails.

SSL Settings

Configure settings for SSL.

Name Description
SslCertificateAsBase64String * A base64 encoded string of the .pfx file (wildcard SSL certificate).
SslCertificatePassword * The password that goes with the certificate.
SslThumbprint * The thumbprint of the wildcard SSL certificate to use when configuring SSL for App Services.

* SSL settings are only required if you specify a value for CustomDomain.

Storage Account Setting

Defines the storage account to use.

Name Description
StorageAccountConnectionString The connection string for the storage account used for saving database backups, packages, assets etc.

Whitelabel Settings

Settings for the whitelabeller.

Name Description
WhiteLabelSecret A string that identifies you as a valid white label reseller. Will be supplied to you by the Weavy team.
SupportEmail The support email address to display in Weavy.
ApplicationName The application/product name you want to display in Weavy.