MVC Templates
From TCAdmin 2.0 Documentation
Revision as of 20:14, 11 August 2019 by TCAWiki (talk | contribs) (→Linux Nginx configuration (optional))
The MVC templates are currently in beta testing.
Contents
Features
- The following features are configurable in the game settings:
- Custom background images per game. Place the images in TCAdmin2\ControlPanel.MVC\Views\Default so they are used in all your custom themes.
- Custom service home page template per game. (change whole layout of the service home page)
- Custom status template per game. (change which information and ports are displayed)
- Join URL
- Responsive design.
- Editable HTML templates.
- Create a new theme in Settings > Themes. Set the type to MVC. A folder will be created in TCAdmin2\ControlPanel.MVC\Views where you can place your custom .cshtml and images.
- Your custom template folder only needs to have the files that have been modified.
- If a file doesn't exist in your custom template it will use the file from the default template. Use the same directory structure as the Default template.
- You can safely add files to the default template folder but all the original files will be overwritten when you update TCAdmin.
- To translate MVC templates go to Settings > Languages > select the language > Other Components > Resources.*.
Requirements
- .NET 4.5 (Windows) or Mono 5.x (Linux) must be installed on your server. MVC templates will not work if you only have .NET 4.0 installed.
- Install TCAdmin version 2.0.127.0 or greater.
Configure TCAdmin
- Edit TCAdmin2\Monitor\TCAdminMonitor.exe.config or /home/tcadmin/Monitor/TCAdminMonitor.exe.config. Add these lines under <appSettings> (update them if they already exist).
<add key="TCAdmin.Public.MVC" value="True" /> <add key="TCAdmin.Public.MVC.WebServicesPath" value="../ControlPanel.MVC" />
- Restart the monitor service.
- Important for Linux users:
- Https is not supported by the built in web server when "TCAdmin.Public.MVC" is set to True. To use https you must configure your control panel with Nginx.
Update the WHMCS module (optional)
Make a backup of your /whmcs/modules/servers/tcadmin2_advanced/tcadmin2_advanced.php and replace it the one in this file. This module has the links updated to work with the MVC template format.
File:Tcadmin2 advanced mvc.zip
Linux Nginx configuration (optional)
Configure Nginx with these instructions but use this default.conf instead of one provided in that tutorial: Configure_the_TCAdmin_website_to_run_with_Nginx If your control panel website was configured with a certificate you must copy the lines starting with ssl_certificate and ssl_certificate_key from the previous configuration.
upstream tcadmin-fcgi { ip_hash; server unix:/home/tcadmin/Temp/fastcgi-socket-1; keepalive 32; } upstream tcadmin-fcgi-mvc { ip_hash; server unix:/home/tcadmin/Temp/fastcgi-socket-mvc-1; keepalive 32; } server { #the following line is required if you want to configure with Let's Encrypt #server_name tcadmin.yourdomain.com; fastcgi_temp_path /home/tcadmin/Temp 1 2; client_body_temp_path /home/tcadmin/Temp 1 2; listen 8880; #access_log /home/tcadmin/Logs/nginx.log; root /home/tcadmin/ControlPanel.MVC; index index.html index.htm default.aspx Default.aspx; #Support for Let's encrypt tools location /.well-known { try_files $uri $uri/ =404; } #Everything else served by fastcgi server location / { root /home/tcadmin/ControlPanel.MVC; fastcgi_ignore_client_abort on; fastcgi_pass tcadmin-fcgi-mvc; include fastcgi_params; fastcgi_split_path_info ^(.+\.as[pmh]x)(.*)$; fastcgi_param PATH_INFO $fastcgi_path_info; fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; fastcgi_keep_conn on; fastcgi_buffering off; fastcgi_read_timeout 600s; gzip off; client_max_body_size 100m; } #Everything else served by fastcgi server location /Aspx { root /home/tcadmin/ControlPanel; fastcgi_ignore_client_abort on; fastcgi_index Default.aspx; fastcgi_pass tcadmin-fcgi; include fastcgi_params; fastcgi_split_path_info ^(.+\.as[pmh]x)(.*)$; fastcgi_param PATH_INFO $fastcgi_path_info; fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; fastcgi_keep_conn on; fastcgi_buffering off; fastcgi_read_timeout 600s; gzip off; client_max_body_size 100m; } }
Windows IIS configuration (optional)
- Configure the website in IIS with these instructions: Configure_the_TCAdmin_website_to_run_with_IIS The only difference is that your main website will point to TCAdmin2\ControlPanel.MVC. If you already have your website configured in IIS just change the website path to TCAdmin2\ControlPanel.MVC.
- In IIS Manager right click on the control panel website and select add application. Set the alias to Aspx and point it to TCAdmin2\ControlPanel. Both must run with the classic .NET application pool.
- Follow steps 1 to 6 for both TCAdmin2\ControlPanel\Web.config and TCAdmin2\ControlPanel.MVC\Web.config Frequently_Asked_Questions#Configuring_your_IIS_website_with_more_than_1_worker_process_.28optional.29
Edit Templates in Visual Studio 2017
- Go to settings > Themes > Create a new MVC theme. This is the template that you will be editing in Visual Studio.
- Copy TCAdmin2\ControlPanel.MVC and TCAdmin2\Monitor\Shared to your PC.
- Rename ControlPanel.MVC\Web.VS2017.config to ControlPanel.MVC\Web.config
- Edit ControlPanel.MVC\Web.config in notepad.
- Update the value of "TCAdmin.SharedPath" to the correct path.
- Update "TCAdmin.Database.MySql.ConnectionString" with your MySQL info. If the connection string is encrypted use these lines and change MYSQLIP, MYSQLUSER, MYSQLPASSWORD and MYSQLDB with the correct values. You can connect to your master's database or to a local copy.
<add key="TCAdmin.Database.MySql.ConnectionString" value="Data Source=MYSQLIP;User Id=MYSQLUSER;Password=MYSQLPASSWORD;Database=MYSQLDB;Pooling=false;Compress=false;Connection Lifetime=900;Connect Timeout=30;Protocol=TCP" /> <add key="TCAdmin.Database.MySql.ConnectionString.Encrypted" value="False" />
- Run Visual Studio.
- select File > Open > Web Site. Select your ControlPanel.MVC folder.
- Select Website > Start Options from the menu.
- In Build > Before running startup page select "No build" and click on OK. Depending on your Visual Studio version this might be in Build > Configuration Manager > Uncheck build next to the website.
- You should be able to run the solution and it will load the control panel website. Only MVC content will render correctly. Classic ASP.NET content will show a server error.
- Don't edit the files from the default template. To edit a specific page copy it from ControlPanel.MVC\Views\Default to ControlPanel.MVC\Views\(YourTemplate) keeping the same directory structure. You don't need to copy all files. If a file is not in your template the default file will be used.
- You should have full intellisense support when editing the template files. If you see an errors about missing references copy the file from Shared to ControlPanel.MVC\bin and restart Visual Studio.
Edit Templates with a text editor
- Create a new theme in Settings > Themes. Set the type to MVC. A folder will be created in TCAdmin2\ControlPanel.MVC\Views where you can place your custom .cshtml and images.
- Copy the file you want to customize from TCAdmin2\ControlPanel.MVC\Views\Default to TCAdmin2\ControlPanel.MVC\Views\(YourTemplate). You must keep the same directory structure of the original file. For example to customize the login page copy Views\Default\Base\Login\Index.cshtml to Views\(YourTemplate)\Base\Login\Index.cshtml and edit Index.cshtml with a text editor.
Going back to the classic ASP.NET themes
If you want to go back to the classic ASP.NET themes:
- Permanently:
- Edit TCAdmin2\Monitor\TCAdminMonitor.exe.config and set the value of TCAdmin.Public.MVC to False
- Restart the monitor.
- Temporary:
- Log out from the MVC panel. View http://x.x.x.x:8880/Aspx/ (the / at the end is important) Then log in again.