Skip to content

Commit c9f8ca1

Browse files
authored
Merge pull request #62 from TotalControlAdmin/develop
Standardize MDX admonition labels and upgrade dependencies
2 parents 03f49e6 + d0f2fab commit c9f8ca1

45 files changed

Lines changed: 147 additions & 142 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎versioned_docs/version-2/billing-api/tcadmin2-advanced-module-for-whmcs.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The tcadmin2_advanced module can be downloaded from our [**client area**](http:/
2929
2. Direct client login from WHMCS to TCAdmin.
3030
3. Configurable options and custom fields can be used to set all the TCAdmin billing API attributes. This makes it flexible. You configure your packages exactly the way you want them.
3131

32-
:::info example
32+
:::info[example]
3333
Configure your packages to ask your clients for their game server's location, hostname and passwords in the WHMCS order page.
3434
:::
3535

@@ -156,17 +156,17 @@ To configure attributes that are not on the Module settings edit file default_va
156156

157157
- To configure it to use a `Custom Field` set the value to `CustomField:FieldName`
158158

159-
:::info example
159+
:::info[example]
160160
`CustomField:Hostname`
161161
:::
162162

163163
- To configure it to use a `Configuration Option` set the value to `ConfigOption:OptionName`
164164

165-
:::info example
165+
:::info[example]
166166
`ConfigOption:Slots`
167167
:::
168168

169-
:::info full example in code
169+
:::info[full example in code]
170170
```php
171171
$billing_api_values["game_additional_slots"] = "ConfigOption:Extra Slots";
172172
```
@@ -379,7 +379,7 @@ If you are going to keep the same custom fields and configurable options in your
379379

380380
If you are going to change custom fields and configurable options we recommend you create a copy of the product and modify the copy (Duplicate link at the top of the products page). When the new product is ready go to the client's service. Change the package and server. Enter the correct values again and save.
381381

382-
:::danger warning
382+
:::danger[warning]
383383
After you change the package all the values of custom fields and configurable options for that service will be lost and you will not be able to recover them.
384384
:::
385385

‎versioned_docs/version-2/customizations/scripts/general-scripts/automatically-create-mysql-database.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: Automatically Create a MySQL Database
55

66
# Automatically Create a MySQL Database
77

8-
:::warning Use MySQL Manager
8+
:::warning[Use MySQL Manager]
99
Rather than utilizing these legacy scripts, we advise installing the MySQL Manager module for optimal results.
1010
:::
1111

@@ -142,7 +142,7 @@ with MySqlManager() as mysql:
142142
- Icon URL: `~/App_Themes/Default/Images/ControlPanel/MenuIcons/Base/Database.png`
143143
- Open in a new window: `Checked`
144144

145-
:::note update
145+
:::note[update]
146146
Newer phpMyAdmin versions don't allow logging in to mysql with the username/password in the url. [https://www.phpmyadmin.net/files/4.9.0.1/](https://www.phpmyadmin.net/files/4.9.0.1/)
147147
:::
148148

‎versioned_docs/version-2/customizations/scripts/general-scripts/backup-restore-scripts-with-ftp-support.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ These scripts are a modified version of [Backup & Restore_Scripts](/customizatio
1111

1212
## Secure your Backups folder
1313

14-
:::danger Urgent Warning: Critical Configuration Step - Neglect at Your Peril!
14+
:::danger[Urgent Warning: Critical Configuration Step - Neglect at Your Peril!]
1515
Failure to execute this pivotal step in the configuration process will render your server alarmingly susceptible to exploitations and security breaches.
1616
:::
1717

‎versioned_docs/version-2/customizations/scripts/general-scripts/backup-restore-scripts.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_label: Backup & Restore Scripts
77

88
## Secure your Backups folder
99

10-
:::danger Urgent Warning: Critical Configuration Step - Neglect at Your Peril!
10+
:::danger[Urgent Warning: Critical Configuration Step - Neglect at Your Peril!]
1111
Failure to execute this pivotal step in the configuration process will render your server alarmingly susceptible to exploitations and security breaches.
1212
:::
1313

‎versioned_docs/version-2/customizations/scripts/general-scripts/stop-service-after-empty-for-2-days.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_label: Restart service when last player disconnects
77

88
This script will stop the game server if it has been empty for 2 days. Add the IronPython script for the query monitoring event.
99

10-
:::info required
10+
:::info[required]
1111
**A MySQL database is required.**
1212
:::
1313

‎versioned_docs/version-2/customizations/scripts/script-objects/service-manager-scripting-variables.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The following variables are available in the `After Started`, `Before Stopped` a
4545

4646
- `ThisService_Pid` - Id of the process that was started/stopped.
4747

48-
:::note example
48+
:::note[example]
4949

5050
```bash
5151
commandline = ThisServiceController.ServiceConfig["Service.CommandLineArguments"]

‎versioned_docs/version-2/customizations/themes/mvc-templates.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ New installations already have MVC enabled by default
4444
```
4545
- Restart the monitor service.
4646

47-
:::danger Important for Linux users
47+
:::danger[Important for Linux users]
4848
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**](/customizations/web-server-configurations/setting-up-nginx).
4949
:::
5050

@@ -104,7 +104,7 @@ We recommend [Visual Studio Code](https://code.visualstudio.com/) for all config
104104

105105
Each .cshtml file in TCAdmin2\ControlPanel.MVC\Views\Default supports adding server and client side code using plugin files. The plugin filename should be `OriginalFile.Plugin.AnyName.cshtml`.
106106

107-
:::info example
107+
:::info[example]
108108
if you want to add code to the HTML HEAD for a live chat software:
109109

110110
- The default HEAD code is in `TCAdmin2\ControlPanel.MVC\Views\Default\Shared\_Head.cshtml`

‎versioned_docs/version-2/customizations/web-server-configurations/setting-up-iis.mdx‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ sidebar_label: Setting up IIS with TCAdmin
77

88
## Prerequisites
99

10-
:::info Prerequisite
10+
:::info[Prerequisite]
1111
Make sure you are running a supported Windows Server environment and have already downloaded and installed TCAdmin 2 before starting this guide.
1212
:::
1313

14-
:::caution Warning for IIS Users
14+
:::caution[Warning for IIS Users]
1515

1616
If you are using IIS with TCAdmin, **do not configure your monitor ports as 80 or 443**. Instead, use the default ports **8880 and 8881**.
1717

@@ -37,7 +37,7 @@ Before setting up IIS with TCAdmin, ensure that:
3737

3838
## Step 2: Set up SQLite Database (Skip if using MySQL)
3939

40-
:::tip Using SQLite
40+
:::tip[Using SQLite]
4141
If you are using an SQLite database, ensure you copy `sqlite3.dll` to the correct location (`C:\Windows\System32`).
4242
:::
4343

@@ -81,15 +81,15 @@ Ensure the **Aspx** application uses the same user as the main website (from ste
8181

8282
### 5. Let's Encrypt (Optional)
8383

84-
:::note Let's Encrypt Option
84+
:::note[Let's Encrypt Option]
8585
Using Let's Encrypt for SSL certificates is recommended if you don’t already have a custom SSL certificate.
8686
:::
8787

8888
If using Let's Encrypt, bind the website to a specific IP and hostname to prevent TCAdmin from changing the certificate.
8989

9090
### 6. Set Folder Permissions
9191

92-
:::caution Permissions
92+
:::caution[Permissions]
9393
Ensure that you assign the correct permissions to `IIS APPPOOL\.NET v4.5`. Missing or incorrect permissions can cause issues with the TCAdmin control panel.
9494
:::
9595

@@ -104,7 +104,7 @@ Ensure that you assign the correct permissions to `IIS APPPOOL\.NET v4.5`. Missi
104104

105105
2. Under **"Connect as..."**, enter the user and password of the Windows user that runs your website.
106106

107-
:::important TCAWeb Setup
107+
:::important[TCAWeb Setup]
108108
If using **TCAWeb**, start the monitor in **console mode** and execute `tcaweb-pass` to obtain the password or attach `TCAdmin2\Monitor\TCAWeb.config` to a support ticket for assistance.
109109
:::
110110

@@ -116,7 +116,7 @@ tcaweb-pass
116116

117117
## Step 4: Database Configuration
118118

119-
:::caution Warning
119+
:::caution[Warning]
120120
Disabling the built-in TCAdmin web server is permanent unless you run the re-enable command provided.
121121
:::
122122

@@ -145,7 +145,7 @@ Disabling the built-in TCAdmin web server is permanent unless you run the re-ena
145145

146146
## Step 6: Configure IIS for Multiple Worker Processes
147147

148-
:::tip Multiple Worker Processes
148+
:::tip[Multiple Worker Processes]
149149
Running multiple worker processes improves performance for high-traffic websites but requires proper session state configuration.
150150
:::
151151

@@ -179,7 +179,7 @@ Running multiple worker processes improves performance for high-traffic websites
179179

180180
### Option 1: Install Let's Encrypt SSL (Recommended)
181181

182-
:::info Let's Encrypt Tip
182+
:::info[Let's Encrypt Tip]
183183
For automatic SSL management, Let's Encrypt is the recommended option. Certify The Web provides a simple interface to manage certificates.
184184
:::
185185

@@ -192,7 +192,7 @@ For automatic SSL management, Let's Encrypt is the recommended option. Certify T
192192

193193
### Option 2: Use a Custom SSL Certificate (optional)
194194

195-
:::caution SSL Certificate Installation
195+
:::caution[SSL Certificate Installation]
196196
Ensure that the SSL certificate is correctly installed in Windows following the linked guide, as an incorrectly configured certificate can cause connection issues.
197197
:::
198198

@@ -202,7 +202,7 @@ Ensure that the SSL certificate is correctly installed in Windows following the
202202

203203
3. Select your custom SSL certificate from the list and apply the changes.
204204

205-
:::tip Best Practices
205+
:::tip[Best Practices]
206206
It’s a good idea to back up your configuration and website settings before making any major changes to the IIS or TCAdmin setup.
207207
:::
208208

‎versioned_docs/version-2/customizations/web-server-configurations/setting-up-nginx.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import TabItem from "@theme/TabItem";
88

99
# Setting up Nginx with TCAdmin
1010

11-
:::warning important
11+
:::warning[important]
1212

1313
The steps provided for configuring nginx in this guide are tailored for Ubuntu 22.04, which is the suggested and preferred operating system. Should you be utilizing a different operating system, consider this guide as a point of reference.
1414

@@ -124,7 +124,7 @@ If there is existing server blocks in the default file you can fully remove it e
124124

125125
### Adding the custom TCAdmin server blocks
126126

127-
:::info Important
127+
:::info[Important]
128128

129129
uncomment the `server_name.` **`(remove the #)`** for the below conf file and enter your own domain name. (**Line: 15**)
130130
:::
@@ -203,7 +203,7 @@ server {
203203

204204
<TabItem value='asp' label='ASP.NET'>
205205

206-
:::warning important
206+
:::warning[important]
207207
This file is for TCAdmin 2.0.127 and earlier or if you have MVC templates disabled.
208208
:::
209209

@@ -306,7 +306,7 @@ sudo snap install core; sudo snap refresh core
306306
```
307307
:::
308308

309-
:::note skip if you have never had the old certbot files installed
309+
:::note[skip if you have never had the old certbot files installed]
310310

311311
In the event that your server previously hosted an older version of Certbot, it's advisable to remove it before proceeding:
312312

‎versioned_docs/version-2/misc/limit-service-cpu-andmemory-usage.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To set the CPU limit go to the game server's service settings, set the value of
1919

2020
### Limiting a service's memory and virtual memory
2121

22-
:::note Important notes
22+
:::note[Important notes]
2323

2424
- If you limit a service's memory it will use more virtual memory. This can increase your server's disk activity.
2525
- If you set the virtual memory limit too low the service might crash while starting up or it might crash later if it requires more memory than allowed.
@@ -30,7 +30,7 @@ To set the memory or virtual memory limit go to the game server's service settin
3030

3131
### Virtual Servers
3232

33-
:::note Important notes
33+
:::note[Important notes]
3434

3535
- When a service belongs to a virtual server the memory limit in service settings can't be set higher than the memory assigned to the virtual server.
3636
- A single process can't use more memory than what is assigned in the virtual server's settings even if there is no limit assigned in service settings.

0 commit comments

Comments
 (0)