Skip to content

Commit 0370374

Browse files
alvarengasvalvarengasv
committed
friendly ver
1 parent d8f38af commit 0370374

14 files changed

Lines changed: 607 additions & 335 deletions

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
"position": 2,
44
"link": {
55
"type": "generated-index",
6-
"description": "Installation documentation for TCAdmin v3 on Windows & Linux"
6+
"description": "Step-by-step installation guides for Windows and Linux. Pick the one that matches your server's operating system."
77
}
88
}

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

Lines changed: 55 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,73 @@ sidebar_label: Linux Installation
55

66
# Linux Installation
77

8-
### Automated TCAdmin installer for Linux
8+
This guide walks you through installing TCAdmin on a Linux server. The automated installer handles all dependencies for you and takes about 5-10 minutes.
99

10-
The automated installer will automatically install TCAdmin and all of the dependencies.
10+
## Before You Begin
1111

12-
:::info
13-
Run the installer below as root
12+
Make sure you have:
13+
14+
- A Linux server that meets the [System Requirements](../system-requirements.mdx)
15+
- **MariaDB or MySQL** installed and running (see [System Requirements](../system-requirements.mdx) for details)
16+
- Your MySQL **username, password, and database name** ready (you'll need these during setup)
17+
- **Root access** (or a user with `sudo` privileges)
18+
- An **SSH connection** to your server (using a tool like PuTTY, your hosting provider's web console, or a terminal)
19+
20+
:::tip Don't have MySQL set up yet?
21+
Install MariaDB first. On Ubuntu/Debian: `sudo apt install mariadb-server`, then run `sudo mysql_secure_installation` to set a root password. On RHEL-based distros: `sudo dnf install mariadb-server` and `sudo systemctl start mariadb`.
1422
:::
1523

24+
## Install TCAdmin
25+
26+
Run the automated installer as **root**:
27+
1628
```bash
1729
bash <(curl -fsSL https://v3.tcafiles.com/linux-beta.sh)
1830
```
1931

20-
<br />
21-
22-
:::tip
23-
24-
If you want to run the command above with sudo:
32+
:::tip Using sudo instead of root?
33+
If you're not logged in as root, prefix the command with `sudo`:
2534

2635
```bash
2736
sudo bash <(curl -fsSL https://v3.tcafiles.com/linux-beta.sh)
2837
```
38+
:::
39+
40+
:::info What does this command do?
41+
It downloads the official TCAdmin installer script from `v3.tcafiles.com` and runs it. The script will:
42+
- Install any missing system dependencies automatically
43+
- Download the TCAdmin components
44+
- Set up systemd services so TCAdmin starts on boot
45+
- Walk you through configuration prompts (component selection, database setup, etc.)
46+
:::
47+
48+
The installer will ask you a series of questions (component selection, database setup, etc.). For a detailed explanation of each step, see the [Master Server Configuration](../initial-configuration/master-server-configuration.mdx) guide.
2949

50+
## After Installation
51+
52+
Once the installer finishes:
53+
54+
- The **TCAdmin Monitor** and **TCAdmin Web** services will start automatically
55+
- Your control panel will be available at **`https://YOUR-SERVER-IP:31001`** from your browser
56+
- Default login: **admin** / **Password!23**
57+
58+
:::warning Browser Security Warning
59+
Your browser will show a security warning because TCAdmin uses a self-signed certificate by default. This is normal — click "Advanced" and then "Proceed" to continue. You can set up a proper certificate later using the [Web Certificate](../initial-configuration/web-certificate.mdx) guide.
60+
:::
61+
62+
:::tip Can't connect?
63+
If you can't reach the panel in your browser, check that port **31001** is open in your firewall:
64+
65+
```bash
66+
# Ubuntu/Debian (UFW)
67+
sudo ufw allow 31001
68+
69+
# RHEL/CentOS/AlmaLinux (firewalld)
70+
sudo firewall-cmd --permanent --add-port=31001/tcp
71+
sudo firewall-cmd --reload
72+
```
3073
:::
3174

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.
75+
## What's Next?
76+
77+
Follow the [Master Server Configuration](../initial-configuration/master-server-configuration.mdx) guide for a detailed walkthrough of the installer prompts and your first login.

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

Lines changed: 42 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,50 @@ sidebar_label: Windows Installation
55

66
# Windows Installation
77

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:
8+
This guide walks you through installing TCAdmin on a Windows server. The process takes about 5-10 minutes.
9+
10+
## Before You Begin
11+
12+
Make sure you have:
13+
14+
- A Windows server that meets the [System Requirements](../system-requirements.mdx)
15+
- **MariaDB or MySQL** installed and running (see [System Requirements](../system-requirements.mdx) for details)
16+
- Your MySQL **username, password, and database name** ready (you'll need these during setup)
17+
- **Administrator access** to the server
18+
19+
:::tip Don't have MySQL set up yet?
20+
Install [MariaDB](https://mariadb.org/download) first. During the MariaDB installer, set a root password and remember it. You can use the root account for TCAdmin, or create a dedicated `tcadmin3` user for better security.
21+
:::
22+
23+
## Install TCAdmin
24+
25+
1. Open **PowerShell** as Administrator.
26+
- Right-click the Start menu and select **Windows PowerShell (Admin)** or **Terminal (Admin)**
27+
28+
2. Run the following command to download and start the installer:
1129

1230
```powershell
1331
& ([scriptblock]::Create((irm "https://v3.tcafiles.com/win-x64-beta.ps1")))
1432
```
1533

16-
4. Follow the [Initial Configuration](../initial-configuration/master-server-configuration.mdx) guide to configure TCAdmin.
34+
3. The installer will walk you through a series of prompts (component selection, database setup, etc.). For a detailed explanation of each step, see the [Master Server Configuration](../initial-configuration/master-server-configuration.mdx) guide.
35+
36+
:::info What does this command do?
37+
It downloads the official TCAdmin installer script from `v3.tcafiles.com` and runs it. The script installs the TCAdmin components, sets up Windows Services, and configures the initial settings based on your answers to the prompts.
38+
:::
39+
40+
## After Installation
41+
42+
Once the installer finishes:
43+
44+
- The **TCAdmin Monitor** and **TCAdmin Web** services will start automatically
45+
- Your control panel will be available at **`https://127.0.0.1:31001`** (or `https://YOUR-SERVER-IP:31001` from another computer)
46+
- Default login: **admin** / **Password!23**
47+
48+
:::warning Browser Security Warning
49+
Your browser will show a security warning because TCAdmin uses a self-signed certificate by default. This is normal — click "Advanced" and then "Proceed" to continue. You can set up a proper certificate later using the [Web Certificate](../initial-configuration/web-certificate.mdx) guide.
50+
:::
51+
52+
## What's Next?
53+
54+
Follow the [Master Server Configuration](../initial-configuration/master-server-configuration.mdx) guide for a detailed walkthrough of the installer prompts and your first login.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
"position": 2,
44
"link": {
55
"type": "generated-index",
6-
"description": "Get started with TCAdmin v3 - installation and initial configuration guides."
6+
"description": "Everything you need to install TCAdmin v3 and get it running — from system requirements to your first login."
77
}
88
}

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
{
22
"label": "Initial Configuration",
33
"position": 3,
4-
"collapsed": false
4+
"collapsed": false,
5+
"link": {
6+
"type": "generated-index",
7+
"description": "After installation, these guides walk you through setting up your master server, adding remote servers, configuring HTTPS, and importing game configurations."
8+
}
59
}

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

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

99
# Master Server Configuration
1010

11-
How to get going with TCAdmin once installed.
11+
This guide walks you through the TCAdmin installer prompts and your first login. By the end, you'll have a fully working control panel.
1212

13-
## Installation Process
13+
:::info What is a "Master Server"?
14+
The master server is your **main** TCAdmin server. It runs the database, the web-based control panel, and the monitor service that manages game servers. If you're only setting up one machine, this is what you need. You can add more servers (called "remote servers") later if you want to scale up.
15+
:::
16+
17+
## The Installer Prompts
1418

15-
After running the TCAdmin installer, you will be prompted with the following:
19+
After running the installer (from the [Windows](../Installation/windows-installation.mdx) or [Linux](../Installation/linux-installation.mdx) guide), you'll be asked a series of questions. Here's what each one means:
1620

1721
### 1. Select Components
1822

19-
Select the components to install:
20-
- **monitor** - The TCAdmin Monitor service that manages game servers
21-
- **web** - The TCAdmin Control Panel web interface
23+
The installer asks which components to install:
24+
- **monitor** — the background service that manages game servers (starts them, stops them, monitors their health)
25+
- **web** — the control panel website you'll use in your browser
2226

23-
Both components are required for a master server installation.
27+
**For a master server, select both.** Both are required for a complete installation.
2428

2529
### 2. Installation Directory
2630

27-
Enter the installation directory or press Enter to use the default:
31+
Choose where TCAdmin files will be stored on disk. You can press **Enter** to accept the default:
2832

2933
<Tabs>
3034
<TabItem value="windows" label="Windows">
@@ -39,114 +43,129 @@ Enter the installation directory or press Enter to use the default:
3943
</TabItem>
4044
</Tabs>
4145

46+
:::tip
47+
The default location works well for most setups. Only change this if you have a specific reason (like a different drive with more disk space).
48+
:::
49+
4250
### 3. Server Type
4351

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
52+
Choose whether this is a **Master** or **Remote** server:
53+
- **Master (primary server with database)** — the main server that hosts the database and coordinates everything
54+
- **Remote (connects to existing master)** — an additional server that connects to an existing master
4755

48-
For your first installation, select **Master**.
56+
**For your first installation, always select Master.**
4957

5058
### 4. Database Configuration
5159

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.
60+
This is where you tell TCAdmin how to connect to your MySQL/MariaDB database. Enter the following details:
61+
62+
| Prompt | What to Enter | Default |
63+
|--------|--------------|---------|
64+
| **MySQL IP or hostname** | The address of your MySQL server. If MySQL is on the same machine, use `localhost`. | `localhost` |
65+
| **MySQL port** | The port MySQL listens on. Unless you changed it, use the default. | `3306` |
66+
| **MySQL username** | A MySQL user with permissions to create and modify tables. `root` works for testing, but a dedicated user like `tcadmin3` is better for production. | — |
67+
| **MySQL password** | The password for the MySQL user you entered above. | — |
68+
| **MySQL database** | The database name to use. TCAdmin will create it if it doesn't exist (and your user has CREATE privileges). | `tcadmin3` |
69+
70+
:::tip Don't have a database user yet?
71+
If you installed MariaDB/MySQL and only have the `root` user, that's fine for getting started. You can create a dedicated user later. If you want to create one now, connect to MySQL and run:
72+
73+
```sql
74+
CREATE USER 'tcadmin3'@'localhost' IDENTIFIED BY 'YourPasswordHere';
75+
CREATE DATABASE tcadmin3;
76+
GRANT ALL PRIVILEGES ON tcadmin3.* TO 'tcadmin3'@'localhost';
77+
FLUSH PRIVILEGES;
78+
```
6179
:::
6280

6381
### 5. Add to PATH
6482

65-
Choose whether to add the TCAdmin CLI (`tca`) to your system PATH for easy access from any terminal.
83+
The installer asks if you want to add the TCAdmin command-line tool (`tca`) to your system PATH. This lets you run `tca` commands from any terminal window without navigating to the installation directory first.
6684

67-
## Backup Your Encryption Key
85+
**Recommended: Yes.** It makes updating and managing TCAdmin easier later.
6886

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.
87+
## Back Up Your Encryption Key
7188

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
89+
:::danger This is the most important step — do not skip it!
90+
After installation, the installer displays a **Master Encryption Key**. This key is used to encrypt all sensitive data in your database (passwords, API keys, etc.).
7791

78-
**If you lose this key, you will NOT be able to decrypt your data!**
79-
:::
92+
**You MUST save this key somewhere safe:**
93+
- Copy it to a password manager (like Bitwarden, 1Password, or KeePass)
94+
- Write it down and store it in a secure location
95+
- **Do NOT** store it on the same server as TCAdmin (if that server dies, you lose the key too)
96+
- Keep backups in multiple places
8097

81-
## Access Your Control Panel
82-
83-
:::info Default Credentials
98+
**If you lose this key, your encrypted data is gone forever — there is no recovery option.**
99+
:::
84100

85-
Username: **admin**
101+
## Log In to Your Control Panel
86102

87-
Password: **Password!23**
88-
89-
:::
103+
Now it's time to open the control panel in your browser!
90104

91105
<Tabs>
92106
<TabItem value="windows" label="Windows">
93107

94-
View `https://127.0.0.1:31001` using the server's browser or `https://public_server_ip:31001` using your PC's browser.
108+
Open your browser and go to **`https://127.0.0.1:31001`** from the server itself, or **`https://YOUR-SERVER-IP:31001`** from another computer (replace with your server's actual IP address).
95109

96110
</TabItem>
97111
<TabItem value="linux" label="Linux">
98112

99-
View `https://public_server_ip:31001` using your PC's browser.
113+
Open your browser on your own computer (not the server) and go to **`https://YOUR-SERVER-IP:31001`** (replace with your server's actual IP address).
100114

101115
</TabItem>
102116
</Tabs>
103117

104-
:::tip
105-
If you are using NAT, make sure you have port forwarded in Windows Firewall, your router, or iptables/ufw.
118+
:::info Default Login Credentials
119+
120+
Username: **admin**
121+
122+
Password: **Password!23**
106123

107-
**Default Ports:**
108-
- HTTP: `31000`
109-
- HTTPS: `31001`
110124
:::
111125

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.
126+
:::tip Can't connect?
127+
If the page doesn't load:
128+
- **Check your firewall** — ports **31000** (HTTP) and **31001** (HTTPS) need to be open
129+
- If your server is behind a router (NAT), you'll need to set up **port forwarding** for these ports
130+
- Wait 30 seconds after installation for the services to fully start
114131
:::
115132

116-
## Getting Started
133+
:::note About the Browser Security Warning
134+
The installer creates a self-signed HTTPS certificate, so your browser will show a security warning the first time. This is expected and safe — just click "Advanced" > "Proceed" (Chrome) or "Accept the Risk" (Firefox). You can replace this with a proper certificate later using the [Web Certificate](web-certificate.mdx) guide.
135+
:::
117136

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.
137+
## Getting Started Widget
119138

120-
### 1. Change Your Password
139+
After logging in, you'll see a **Getting Started** widget on your dashboard. It walks you through the essential first-time setup:
121140

122-
Secure your account by changing the default password. Click the **Change Password** button in the widget to update your password.
141+
### 1. Change Your Password
123142

124-
:::warning
125-
You must change the default password before proceeding with other setup tasks.
126-
:::
143+
Click **Change Password** and set a strong, unique password. You won't be able to proceed until this is done — it's there to keep your server safe.
127144

128145
### 2. Configure Your License
129146

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.
147+
Click on the server name in the widget to enter your TCAdmin license key. Your license unlocks the ability to import games from the Plugin Repository and enables all features.
131148

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.
149+
:::info Don't have a license key yet?
150+
You can use your existing TCAdmin v2 master license key to preview v3.
151+
:::
133152

134153
### 3. Import Game Configurations
135154

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.
155+
Click **Import** to open the Plugin Repository and install pre-built game configurations. This is the fastest way to get started — the repository has ready-to-go setups for popular games like **Minecraft, CS2, Rust, ARK**, and many more.
139156

140-
:::tip
141-
The plugin repository contains pre-configured settings for popular games like Minecraft, CS2, Rust, ARK, and many more.
142-
:::
157+
You can also click **Skip** if you'd rather configure games manually later.
143158

144159
### 4. Import Docker Configurations
145160

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.
161+
If you want to run game servers inside Docker containers, click **Import** to install Docker blueprint configurations. Otherwise, click **Skip**.
149162

150163
---
151164

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!
165+
Once you've completed all the steps, the widget shows a success message. Your TCAdmin panel is ready to use!
166+
167+
## What's Next?
168+
169+
- [Set up a Web Certificate](web-certificate.mdx) — get a proper HTTPS certificate so your browser stops showing security warnings
170+
- [Browse the Plugin Repository](plugin-repository.mdx) — learn more about installing games, scripts, themes, and more
171+
- [Add a Remote Server](remote-server-configuration.mdx) — scale to multiple machines if you need more capacity

0 commit comments

Comments
 (0)