Installing Control Panel
- 3 minutes to read
The Control Panel represents a web application to manage files and configure the Design Editor.
Prerequisites
If you are installing this application to a clean Windows Server, make sure you have installed the following components:
- IIS installed with ASP.NET 4.5 or higher (server roles .NET Extensibility 4.5 and ASP.NET 4.5).
- Microsoft .NET Framework 4.8 or higher.
- Both Microsoft Visual C++ Redistributable Package x64 (latest supported) and Microsoft Visual C++ Redistributable Package x86 (latest supported).
Distribution Package
You can contact our support team to get the Control Panel for your Windows server. This distribution package represents the Hosted_<version>.zip file and contains the compiled application.
Deploying the Control Panel
To deploy this application:
Unzip the archive to a new IIS folder, for example, D:\inetpub\control-panel.
In the IIS manager, create a new site:
- Right-click Sites and then click Add Website.
- Enter the Site name (
ControlPanel
) and its Physical path (D:\inetpub\control-panel
) - Click OK.
In Application Pools, right-click ControlPanel, click Basic Settings, select .Net CLR Version v4, set the Integrated pipeline mode, and click OK.
Set up permissions for the D:\inetpub\control-panel\App_Data folder:
- In the File Explorer, browse to D:\inetpub\control-panel, right-click App_Data, and click Properties. On the General tab, uncheck Read-only, then click Apply.
- On the Security tab, click Edit, then click Add. Type in
IIS AppPool\ControlPanel
, click Check Names, and after it finds the account (the account's name should become underlined: ControlPanel), click OK. - Select the Modify permission and click OK two more times.
File System of the Design Editor Instance
After you have deployed the Control Panel, you can add your images, fonts, product templates, and color profiles to the assets folder of your instance. All the files you upload need to be placed in the correct folders in the Design Editor file system in order for them to be used. Let's take a look at an overview of the Design Editor file system:
- \assets\ contains resources of your instance.
- \assets\ColorProfiles\ contains color profiles for color management.
- \assets\designs\ contains product templates. Templates can be organized in subfolders.
- \assets\fonts\ contains custom fonts that can be used in your products.
- \assets\helpers\ contains watermarks and texture images.
- \assets\images\ contains public images, which can be utilized by users while customizing products. You can create subfolders to categorize images.
- \assets\mockups\ contains mockup files. Mockups help to visualize a product, but they are not rendered to hi-resolution images.
- \Editors\ contains configuration files and installed packages of the UI Framework.
- \Editors\configs\ contains configuration files.
- \Editors\UIF-<version>\ contains a multi-step editor.
- \userdata\<someUserId>\ is created for every user who interacts with the Design Editor. Here,
<someUserId>
is the identifier you specify using the Design Editor API via the userId argument. If the argument is not specified, then thedefault
user identifier is utilized.- \userdata\<someUserId>\states\ contains products created by the
<someUserId>
user. - \userdata\<someUserId>\images\ contains images uploaded by the
<someUserId>
user.
- \userdata\<someUserId>\states\ contains products created by the
For more information about fonts, templates, mockups, and public images, see how to configure products.
You can manage the files and folders of your Design Editor instance by using the web file manager.
Running the Control Panel
Let us assume that your Control Panel shares a domain name with the main website and is located in the control-panel virtual folder. To run this application, navigate to https://example.com/control-panel/ in your browser.
If you face any problem with the Control Panel, please contact our support team.