Skip to content

Commit a820a8d

Browse files
AdamG100AdamG100
authored
Merge pull request #36 from AdamG100/master
Add custom header icons and update documentation
2 parents 92e841c + cc5bc54 commit a820a8d

12 files changed

Lines changed: 232 additions & 92 deletions

‎docs/getting-started/system-requirements.mdx‎

Lines changed: 63 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ sidebar_position: 1
33
sidebar_label: System Requirements
44
---
55

6-
import Tabs from '@theme/Tabs';
7-
import TabItem from '@theme/TabItem';
6+
import Tabs from "@theme/Tabs";
7+
import TabItem from "@theme/TabItem";
88

99
# System Requirements
1010

@@ -13,51 +13,52 @@ System requirements for optimal performance:
1313
<Tabs>
1414
<TabItem value="windows" label="Windows">
1515

16-
| Operating System | Version | Supported | Notes |
17-
| ----------------------- | ------------------- | --------- | ----------------------- |
18-
| Windows Server | 2012 R2 | No | Support End October 10, 2023 |
19-
| Windows Server | 2016 | Yes | Support End Jan 12, 2027 |
20-
| Windows Server | 2019 | Yes | Support End Jan 9, 2029 |
21-
| Windows Server | 2022 | Yes | Support End Oct 14, 2031 |
22-
| Windows | 10 (32/64 bit) | Yes | Support End Oct 14, 2025 |
23-
| Windows | 11 | Yes | In Support |
16+
| Operating System | Version | Supported | Notes |
17+
| ---------------- | -------------- | --------- | ---------------------------- |
18+
| Windows Server | 2012 R2 | No | Support End October 10, 2023 |
19+
| Windows Server | 2016 | Yes | Support End Jan 12, 2027 |
20+
| Windows Server | 2019 | Yes | Support End Jan 9, 2029 |
21+
| Windows Server | 2022 | Yes | Support End Oct 14, 2031 |
22+
| Windows | 10 (32/64 bit) | Yes | Support End Oct 14, 2025 |
23+
| Windows | 11 | Yes | In Support |
24+
| Windows Server | 2025 | Yes | In Support |
2425

2526
### Dependancies
2627

2728
- [Microsoft .NET Framework 4.7.2 and above](https://dotnet.microsoft.com/en-us/download/dotnet-framework)
2829
- [Npcap with "Install Npcap in WinPcap API-compatible mode" enabled (for bandwidth monitor)
29-
](https://npcap.com/dist/npcap-1.75.exe)
30+
](https://npcap.com/#download) Download the installer
3031

3132
### Optional components
3233

3334
- [Recommended registry changes](/misc/recommended-registry-changes)
34-
- A MySQL database located on the same server is recommended for best performance. [Mysql](https://dev.mysql.com/downloads/mysql/) **(TCAdmin Supports MySQL 8 Password Encryption for Authentication)**
35+
- A MySQL database located on the same server is recommended for best performance. [MariaDB](https://mariadb.org/download) **(TCAdmin Supports MySQL 8 Password Encryption for Authentication)**
36+
3537
#### Required by almost all games
38+
3639
- [Microsoft Visual c++ **(x64)**](https://aka.ms/vs/17/release/vc_redist.x64.exe) 2015 to 2022
3740
- [Microsoft Visual c++ **(x86)**](https://aka.ms/vs/17/release/vc_redist.x86.exe) 2015 to 2022
3841
- [Direct X](https://www.microsoft.com/en-us/download/details.aspx?id=35&6B49FDFB-8E5B-4B07-BC31-15695C5A2143=1)
3942
- Java **required for Minecraft.** We recommend [Adoptium variant](https://adoptium.net/)
4043

41-
4244
</TabItem>
4345

4446
<TabItem value="linux" label="Linux">
4547

46-
| Operating System | Version | Supported | Notes |
47-
| ---------------- | -------- | --------- | ----- |
48-
| Ubuntu | 16.04 | No | LTS End April 30th 2021 |
49-
| Ubuntu | 18.04 | No | LTS End May 31 2023 |
50-
| Ubuntu | 20.04 | No | LTS End May 31 2025 |
51-
| Ubuntu | 22.04 | Yes | LTS End April 2027 |
52-
| Debian | 9 | No | LTS End June 30 2022 |
53-
| Debian | 10 | No | LTS End July 1 2022 |
54-
| Debian | 11 | Yes | LTS End June 2026 |
55-
| CentOS | 6 | No | LTS End November 30 2020 |
56-
| CentOS | 7 | No | LTS End June 30 2024 |
57-
| CentOS | 8 | No | LTS End December 31, 2021 (Moved to Centos stream) |
58-
| CentOS Stream | 8 | No | LTS End May 31 2024 |
59-
| CentOS Stream | 9 | Yes | In Support |
60-
48+
| Operating System | Version | Supported | Notes |
49+
| ---------------- | ------- | --------- | -------------------------------------------------- |
50+
| Ubuntu | 16.04 | No | LTS End April 30th 2021 |
51+
| Ubuntu | 18.04 | No | LTS End May 31 2023 |
52+
| Ubuntu | 20.04 | No | LTS End May 31 2025 |
53+
| Ubuntu | 22.04 | Yes | LTS End April 2027 |
54+
| Debian | 9 | No | LTS End June 30 2022 |
55+
| Debian | 10 | No | LTS End July 1 2022 |
56+
| Debian | 11 | Yes | LTS End June 2026 |
57+
| CentOS | 6 | No | LTS End November 30 2020 |
58+
| CentOS | 7 | No | LTS End June 30 2024 |
59+
| CentOS | 8 | No | LTS End December 31, 2021 (Moved to Centos stream) |
60+
| CentOS Stream | 8 | No | LTS End May 31 2024 |
61+
| CentOS Stream | 9 | Yes | In Support |
6162

6263
<br />
6364

@@ -82,54 +83,62 @@ If you accidentally install Mono 4 you must uninstall it before installing Mono
8283
#### Install Mono 6.0 or greater
8384

8485
[Add the Xamarin repository from mono-project.com](https://www.mono-project.com/download/stable/#download-lin-centos)
85-
Then execute:
86+
Then execute:
87+
88+
```bash
89+
yum install mono-complete mono-basic xsp
90+
```
8691

87-
```bash
88-
yum install mono-complete mono-basic xsp
89-
```
9092
Install 32bit libraries for steamcmd and 32bit games: [SteamCmd Libraries](https://developer.valvesoftware.com/wiki/SteamCMD#32-Bit_Libraries_on_64-Bit_Linux_Systems)
9193
Execute these commands to install other dependencies.
92-
```bash
93-
yum -y install libpcap schedutils lsof glibc.i686 libstdc++.i686 socat screen
94-
```
95-
Optional: MySQL 5.1 or greater.
94+
95+
```bash
96+
yum -y install libpcap schedutils lsof glibc.i686 libstdc++.i686 socat screen
97+
```
98+
99+
- A MySQL database located on the same server is recommended for best performance. [MariaDB](https://mariadb.org/download) **(TCAdmin Supports MySQL 8 Password Encryption for Authentication)**
96100

97101
### Debian 64bit
98102

99103
#### Install Mono 6.0 or greater
100104

101105
[Add the Xamarin repository from mono-project.com](https://www.mono-project.com/download/stable/#download-lin-centos)
102-
Then execute:
106+
Then execute:
107+
108+
```bash
109+
apt-get install mono-complete mono-vbnc mono-xsp
110+
```
103111

104-
```bash
105-
apt-get install mono-complete mono-vbnc mono-xsp
106-
```
107112
Install 32bit libraries for steamcmd and 32bit games: [SteamCmd Libraries](https://developer.valvesoftware.com/wiki/SteamCMD#32-Bit_Libraries_on_64-Bit_Linux_Systems)
108113
Execute these commands to install other dependencies.
109-
```bash
110-
apt-get install libpcap0.8 util-linux lsof socat screen
111-
```
112-
Optional: MySQL 5.1 or greater.
114+
115+
```bash
116+
apt-get install libpcap0.8 util-linux lsof socat screen
117+
```
118+
119+
- A MySQL database located on the same server is recommended for best performance. [MariaDB](https://mariadb.org/download) **(TCAdmin Supports MySQL 8 Password Encryption for Authentication)**
113120

114121
### Ubuntu 64bit
115122

116123
#### Install Mono 6.0 or greater
117124

118125
[Add the Xamarin repository from mono-project.com](https://www.mono-project.com/download/stable/#download-lin-centos)
119-
Then execute:
126+
Then execute:
127+
128+
```bash
129+
apt-get install mono-complete mono-vbnc mono-xsp
130+
```
120131

121-
```bash
122-
apt-get install mono-complete mono-vbnc mono-xsp
123-
```
124132
Install 32bit libraries for steamcmd and 32bit games: [SteamCmd Libraries](https://developer.valvesoftware.com/wiki/SteamCMD#32-Bit_Libraries_on_64-Bit_Linux_Systems)
125133
Execute these commands to install other dependencies.
126-
```bash
127-
apt-get install libncurses5 libncursesw5 libpcap0.8 util-linux lsof screen socat iptables-persistent
128-
```
129-
Optional: MySQL 5.1 or greater.
130134

131-
Java **required for Minecraft.** We recommend [Adoptium variant](https://adoptium.net/)
135+
```bash
136+
apt-get install libncurses5 libncursesw5 libpcap0.8 util-linux lsof screen socat iptables-persistent
137+
```
132138

139+
- A MySQL database located on the same server is recommended for best performance. [MariaDB](https://mariadb.org/download) **(TCAdmin Supports MySQL 8 Password Encryption for Authentication)**
140+
141+
Java **required for Minecraft.** We recommend [Adoptium variant](https://adoptium.net/)
133142

134143
</TabItem>
135144
</Tabs>
@@ -140,4 +149,4 @@ Java **required for Minecraft.** We recommend [Adoptium variant](https://adoptiu
140149

141150
If you plan on having remote servers, it is recommended that you use a MySQL database. You can convert your SQLite database to MySQL at any time using the conversion tool included in TCAdmin.
142151

143-
:::
152+
:::

‎docs/using-tcadmin/hosting-control-panel-seperatly.mdx‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,13 @@ If you ever need to enable the built in web server again execute this command.
7474

7575
```sql
7676
INSERT INTO tc_server_enabled_components (module_id, component_id, server_id) values ('07405876-e8c2-4b24-a774-4ef57f596384', 2, 1);
77-
```
77+
```
78+
79+
## Common Errors
80+
81+
If you encounter a **"wrong username or password"** error when trying to log in to the new separate control panel, please check the following:
82+
83+
- Copy the files from the master's `TCAdmin2\ControlPanel.MVC\bin-extensions` directory to the same directory on the new server.
84+
- Copy the files from the master's `TCAdmin2\Monitor\Shared\bin-extensions` directory to the same directory on the new server.
85+
86+
You should then be able to now login to the control panel.

‎docusaurus.config.js‎

Lines changed: 70 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,125 @@
11
// @ts-check
22
/** @type {import('@docusaurus/types').Config} */
3-
import { themes as prismThemes } from 'prism-react-renderer';
3+
import { themes as prismThemes } from "prism-react-renderer";
44

5-
const lightLogo = 'img/tcadmin-logo.png';
6-
const darkLogo = 'img/TCAdmin_White.png';
5+
const lightLogo = "img/tcadmin-logo.png";
6+
const darkLogo = "img/TCAdmin_White.png";
77

88
const config = {
9-
title: 'TCAdmin Documentation',
10-
tagline: 'TCAdmin Documentation',
11-
favicon: 'img/cropped-tcadmin-favicon-32x32.png',
12-
url: 'https://docs.tcadmin.com',
13-
baseUrl: '/',
14-
organizationName: 'TotalControlAdmin',
15-
projectName: 'tcadmin-docs',
16-
onBrokenLinks: 'throw',
17-
onBrokenMarkdownLinks: 'warn',
18-
onBrokenAnchors: 'ignore',
9+
title: "TCAdmin Documentation",
10+
tagline: "TCAdmin Documentation",
11+
favicon: "img/cropped-tcadmin-favicon-32x32.png",
12+
url: "https://docs.tcadmin.com",
13+
baseUrl: "/",
14+
organizationName: "TotalControlAdmin",
15+
projectName: "tcadmin-docs",
16+
onBrokenLinks: "throw",
17+
onBrokenMarkdownLinks: "warn",
18+
onBrokenAnchors: "ignore",
1919

2020
i18n: {
21-
defaultLocale: 'en',
22-
locales: ['en'],
21+
defaultLocale: "en",
22+
locales: ["en"],
2323
},
2424

2525
presets: [
2626
[
27-
'classic',
27+
"classic",
2828
{
2929
docs: {
30-
routeBasePath: '/',
31-
sidebarPath: './sidebars.js',
30+
routeBasePath: "/",
31+
sidebarPath: "./sidebars.js",
3232
showLastUpdateTime: true,
33-
editUrl: 'https://github.com/TotalControlAdmin/tcadmin-docs/blob/master/',
33+
editUrl:
34+
"https://github.com/TotalControlAdmin/tcadmin-docs/blob/master/",
3435
},
3536
blog: false,
3637
theme: {
37-
customCss: './src/css/custom.css',
38+
customCss: "./src/css/custom.css",
3839
},
3940
},
4041
],
4142
],
4243

43-
themes: ['docusaurus-theme-search-typesense'],
44+
themes: ["docusaurus-theme-search-typesense"],
4445

4546
themeConfig: {
46-
image: 'img/tcadmin-logo.png',
47+
image: "img/tcadmin-logo.png",
4748
typesense: {
48-
typesenseCollectionName: 'tcadmin-docs',
49+
typesenseCollectionName: "tcadmin-docs",
4950
typesenseServerConfig: {
5051
nodes: [
5152
{
52-
host: 'typesense.tcadmin.k8s.ovh.alexr03.dev',
53+
host: "typesense.tcadmin.k8s.ovh.alexr03.dev",
5354
port: 443,
54-
protocol: 'https',
55+
protocol: "https",
5556
},
5657
],
57-
apiKey: 'fzpKd6Esfg47mr8Nh9f4Km1Kbbi1OiFM',
58+
apiKey: "fzpKd6Esfg47mr8Nh9f4Km1Kbbi1OiFM",
5859
},
5960
contextualSearch: true,
6061
},
6162
navbar: {
62-
title: '',
63+
title: "",
6364
logo: {
64-
alt: 'TCAdmin Docs',
65+
alt: "TCAdmin Docs",
6566
src: lightLogo,
6667
srcDark: darkLogo,
6768
},
6869
items: [
69-
{ href: 'https://github.com/TotalControlAdmin/tcadmin-docs', label: 'GitHub', position: 'right' },
70-
{ href: 'https://discord.gg/ptN2pGf', label: 'Discord', position: 'right' },
71-
{ href: 'https://community.tcadmin.com', label: 'Forums', position: 'right' },
72-
{ href: 'https://www.tcadmin.com/', label: 'Main Website', position: 'right' },
73-
{ href: 'https://clients.tcadmin.com/billing/clientarea.php', label: 'Billing', position: 'right' },
70+
{
71+
type: "docSidebar",
72+
sidebarId: "tutorialSidebar",
73+
position: "left",
74+
label: "Documentation",
75+
},
76+
{
77+
href: "https://github.com/TotalControlAdmin/tcadmin-docs",
78+
position: "right",
79+
80+
className: "header-github-link", // Add custom classes for styling icons
81+
"aria-label": "GitHub repository",
82+
},
83+
{
84+
href: "https://discord.com/invite/ptN2pGf",
85+
position: "right",
86+
87+
className: "header-discord-link",
88+
},
89+
{
90+
href: "https://www.tcadmin.com/",
91+
position: "right",
92+
93+
className: "header-website-link",
94+
},
95+
{
96+
href: "https://clients.tcadmin.com/billing/clientarea.php",
97+
position: "right",
98+
99+
className: "header-billing-link",
100+
},
101+
{
102+
href: "https://community.tcadmin.com",
103+
position: "right",
104+
105+
className: "header-forum-link",
106+
},
74107
],
75108
},
76109
footer: {
77-
style: 'dark',
110+
style: "dark",
78111
links: [],
79-
copyright: `Copyright © ${new Date().getFullYear()} TCAdmin. Built with Docusaurus.`,
112+
copyright: `Copyright © ${new Date().getFullYear()} TCADMIN.COM, ALL RIGHTS RESERVED.`,
80113
},
81114
prism: {
82115
theme: prismThemes.github,
83116
darkTheme: prismThemes.dracula,
84-
additionalLanguages: ['php', 'cshtml', 'csharp'],
117+
additionalLanguages: ["php", "cshtml", "csharp"],
85118
},
86119
colorMode: {
87120
respectPrefersColorScheme: true,
88121
},
89122
},
90123
};
91124

92-
export default config;
125+
export default config;

0 commit comments

Comments
 (0)