Skip to content

Commit 6bdacd0

Browse files
alvarengasvalvarengasv
committed
v3 docs
1 parent 57302bd commit 6bdacd0

12 files changed

Lines changed: 763 additions & 2 deletions

File tree

‎versioned_docs/version-3/getting-started/Installation/_category_.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Installation",
3+
"position": 2,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Installation documentation for TCAdmin v3 on Windows & Linux"
7+
}
8+
}

‎versioned_docs/version-3/getting-started/Installation/linux-installation.mdx‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
sidebar_position: 2
3+
sidebar_label: Linux Installation
4+
---
5+
6+
# Linux Installation
7+
8+
### Automated TCAdmin installer for Linux
9+
10+
The automated installer will automatically install TCAdmin and all of the dependencies.
11+
12+
:::info
13+
Run the installer below as root
14+
:::
15+
16+
```bash
17+
bash <(curl -fsSL https://v3.tcafiles.com/linux-beta.sh)
18+
```
19+
20+
<br />
21+
22+
:::tip
23+
24+
If you want to run the command above with sudo:
25+
26+
```bash
27+
sudo bash <(curl -fsSL https://v3.tcafiles.com/linux-beta.sh)
28+
```
29+
30+
:::
31+
32+
1. Make sure you have reviewed the [System Requirements](../system-requirements.mdx).
33+
2. Follow the [Initial Configuration](../initial-configuration/master-server-configuration.mdx) guide to configure TCAdmin.

‎versioned_docs/version-3/getting-started/Installation/windows-installation.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
sidebar_position: 1
3+
sidebar_label: Windows Installation
4+
---
5+
6+
# Windows Installation
7+
8+
1. Make sure you have reviewed the [System Requirements](../system-requirements.mdx).
9+
2. Open **PowerShell** as Administrator.
10+
3. Execute the following command:
11+
12+
```powershell
13+
& ([scriptblock]::Create((irm "https://v3.tcafiles.com/win-x64-beta.ps1")))
14+
```
15+
16+
4. Follow the [Initial Configuration](../initial-configuration/master-server-configuration.mdx) guide to configure TCAdmin.

‎versioned_docs/version-3/getting-started/_category_.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Getting Started",
3+
"position": 2,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Get started with TCAdmin v3 - installation and initial configuration guides."
7+
}
8+
}

‎versioned_docs/version-3/getting-started/initial-configuration/_category_.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"label": "Initial Configuration",
3+
"position": 3,
4+
"collapsed": false
5+
}

‎versioned_docs/version-3/getting-started/initial-configuration/master-server-configuration.mdx‎

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
---
2+
sidebar_position: 1
3+
sidebar_label: Master Server Configuration
4+
---
5+
6+
import Tabs from "@theme/Tabs";
7+
import TabItem from "@theme/TabItem";
8+
9+
# Master Server Configuration
10+
11+
How to get going with TCAdmin once installed.
12+
13+
## Installation Process
14+
15+
After running the TCAdmin installer, you will be prompted with the following:
16+
17+
### 1. Select Components
18+
19+
Select the components to install:
20+
- **monitor** - The TCAdmin Monitor service that manages game servers
21+
- **web** - The TCAdmin Control Panel web interface
22+
23+
Both components are required for a master server installation.
24+
25+
### 2. Installation Directory
26+
27+
Enter the installation directory or press Enter to use the default:
28+
29+
<Tabs>
30+
<TabItem value="windows" label="Windows">
31+
32+
**Default:** `C:\Program Files\TCAdmin3`
33+
34+
</TabItem>
35+
<TabItem value="linux" label="Linux">
36+
37+
**Default:** `/opt/tcadmin3`
38+
39+
</TabItem>
40+
</Tabs>
41+
42+
### 3. Server Type
43+
44+
Select whether this is a **Master** or **Remote** server:
45+
- **Master (primary server with database)** - The main server that hosts the database and coordinates all operations
46+
- **Remote (connects to existing master)** - Additional servers that connect to an existing master installation
47+
48+
For your first installation, select **Master**.
49+
50+
### 4. Database Configuration
51+
52+
Enter your MySQL database connection details:
53+
- **MySQL IP or hostname** - The address of your MySQL server (default: `localhost`)
54+
- **MySQL port** - The port MySQL is listening on (default: `3306`)
55+
- **MySQL username** - A MySQL user with permissions to create/modify tables
56+
- **MySQL password** - The password for the MySQL user
57+
- **MySQL database** - The database name (default: `tcadmin3`)
58+
59+
:::tip
60+
If the database doesn't exist and your MySQL user has CREATE privileges, the installer will offer to create it for you.
61+
:::
62+
63+
### 5. Add to PATH
64+
65+
Choose whether to add the TCAdmin CLI (`tca`) to your system PATH for easy access from any terminal.
66+
67+
## Backup Your Encryption Key
68+
69+
:::danger Critical Security Step
70+
After installation completes, you will be shown a **Master Encryption Key**. This key is used to encrypt all sensitive data in your database.
71+
72+
**You MUST backup this key securely:**
73+
- Store it in a password manager or secure vault
74+
- Do NOT store it on the same server as TCAdmin
75+
- Keep multiple secure backups in different locations
76+
- This key is required for disaster recovery
77+
78+
**If you lose this key, you will NOT be able to decrypt your data!**
79+
:::
80+
81+
## Access Your Control Panel
82+
83+
:::info Default Credentials
84+
85+
Username: **admin**
86+
87+
Password: **Password!23**
88+
89+
:::
90+
91+
<Tabs>
92+
<TabItem value="windows" label="Windows">
93+
94+
View `https://127.0.0.1:31001` using the server's browser or `https://public_server_ip:31001` using your PC's browser.
95+
96+
</TabItem>
97+
<TabItem value="linux" label="Linux">
98+
99+
View `https://public_server_ip:31001` using your PC's browser.
100+
101+
</TabItem>
102+
</Tabs>
103+
104+
:::tip
105+
If you are using NAT, make sure you have port forwarded in Windows Firewall, your router, or iptables/ufw.
106+
107+
**Default Ports:**
108+
- HTTP: `31000`
109+
- HTTPS: `31001`
110+
:::
111+
112+
:::note Self-Signed Certificate
113+
The installer creates a self-signed certificate for HTTPS connections. Your browser will show a security warning - this is expected. You can proceed past the warning or configure a trusted certificate later.
114+
:::
115+
116+
## Getting Started
117+
118+
After logging in, you will see the **Getting Started** widget on your dashboard. This widget guides you through the essential setup tasks to get your TCAdmin system ready.
119+
120+
### 1. Change Your Password
121+
122+
Secure your account by changing the default password. Click the **Change Password** button in the widget to update your password.
123+
124+
:::warning
125+
You must change the default password before proceeding with other setup tasks.
126+
:::
127+
128+
### 2. Configure Your License
129+
130+
Set up a valid license for your server to unlock all features. Click on the server name in the widget to open the license configuration dialog.
131+
132+
Enter your license key to activate your TCAdmin installation. Without a valid license, you will not be able to import games or Docker configurations from the plugin repository.
133+
134+
### 3. Import Game Configurations
135+
136+
Add game and voice service configurations to start hosting game servers. Click **Import** to browse and install game configurations from the TCAdmin plugin repository.
137+
138+
You can also click **Skip** if you plan to configure games manually later.
139+
140+
:::tip
141+
The plugin repository contains pre-configured settings for popular games like Minecraft, CS2, Rust, ARK, and many more.
142+
:::
143+
144+
### 4. Import Docker Configurations
145+
146+
Set up Docker blueprints for containerized services. Click **Import** to browse available Docker configurations from the plugin repository.
147+
148+
You can also click **Skip** if you don't plan to use Docker containers.
149+
150+
---
151+
152+
Once all tasks are completed, the widget will display a success message and you can close it. Your TCAdmin system is now ready to use!

0 commit comments

Comments
 (0)