Skip to content

Commit d8f38af

Browse files
alvarengasvalvarengasv
committed
docs
1 parent 2f817ca commit d8f38af

6 files changed

Lines changed: 280 additions & 6 deletions

File tree

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,5 @@
1818
npm-debug.log*
1919
yarn-debug.log*
2020
yarn-error.log*
21+
/.vs
22+
/nul

‎docusaurus.config.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ const config = {
3838
editUrl:
3939
"https://github.com/TotalControlAdmin/tcadmin-docs/blob/master/",
4040
lastVersion: "2",
41-
onlyIncludeVersions: ["2"], // v3 hidden until public release
41+
onlyIncludeVersions: ["2", "3"], // v3 hidden until public release
4242
includeCurrentVersion: false,
4343
versions: {
4444
"2": {

‎versioned_docs/version-3/getting-started/initial-configuration/plugin-repository.mdx‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
---
2+
sidebar_position: 4
3+
sidebar_label: Plugin Repository
4+
---
5+
6+
# Plugin Repository
7+
8+
The Plugin Repository allows you to browse, install, and update game configurations, Docker blueprints, scripts, themes, and language packs from centralized repositories.
9+
10+
## Accessing the Plugin Repository
11+
12+
1. Go to **Settings** > **Plugin Repositories**
13+
2. Click on a repository to browse its contents
14+
15+
## Default Repository
16+
17+
TCAdmin includes a default plugin repository maintained by TCAdmin that contains official game configurations and other plugins. This repository cannot be deleted or modified.
18+
19+
## Browsing Plugins
20+
21+
When you open a repository, plugins are organized into tabs:
22+
23+
| Tab | Description |
24+
|-----|-------------|
25+
| **Games** | Game server configurations (Minecraft, CS2, Rust, ARK, etc.) |
26+
| **Docker** | Docker blueprint configurations for containerized services |
27+
| **Scripts** | Game scripts, Docker scripts, and script modules |
28+
| **Themes** | UI themes to customize the control panel appearance |
29+
| **Languages** | Language packs for localization |
30+
31+
Each plugin card displays:
32+
- Plugin name and author
33+
- Short description
34+
- Version number and available versions
35+
- Tags for categorization
36+
- Last update time
37+
38+
## Installing a Plugin
39+
40+
1. Click **View Details** on a plugin card
41+
2. Select the **Version** you want to install
42+
3. Select the specific configuration file (some plugins include multiple configurations)
43+
4. Optionally select an existing item to update instead of creating a new one
44+
5. Click **Install**
45+
46+
The installation runs as a background task. A dialog will show the progress and any messages.
47+
48+
:::warning Updating Existing Items
49+
When installing a plugin, you can choose to update an existing game, Docker blueprint, script, theme, or language instead of creating a new one. If you made customizations to the existing item, they will be lost.
50+
:::
51+
52+
## Adding Third-Party Repositories
53+
54+
You can add additional plugin repositories from third-party sources:
55+
56+
1. Go to **Settings** > **Plugin Repositories**
57+
2. Click **Add**
58+
3. Enter the repository details:
59+
- **Name** - A friendly name for the repository
60+
- **Git URL** - The Git repository URL
61+
- **Branch** - The branch to use (default: `master`)
62+
- **Credential** - Select a saved credential for private repositories
63+
4. Click **Save**
64+
65+
:::warning Security Notice
66+
Third-party plugin repositories are added at your own risk. Plugins can contain code that executes on your server. Only add repositories from sources you trust.
67+
:::
68+
69+
## Repository Sync
70+
71+
Repositories sync automatically from their Git source. If a repository shows "Not Synced":
72+
73+
1. Open the repository
74+
2. Click **Sync Repository**
75+
3. Wait for the sync to complete
76+
77+
The sync status shows:
78+
- **Synced** - Repository is up to date
79+
- **Not Synced** - Repository needs to sync (may show commits ahead/behind)
80+
81+
## Credentials
82+
83+
For private Git repositories, you can save credentials:
84+
85+
1. Go to **Settings** > **Plugin Repositories**
86+
2. Click **Credentials** in the left menu
87+
3. Click **Add** to create a new credential
88+
4. Enter the username and password/token
89+
5. Save the credential
90+
91+
You can then select this credential when adding or editing a repository.
92+
93+
## Plugin Types
94+
95+
### Game Configurations
96+
97+
Game plugins contain complete server configurations including:
98+
- Executable paths and command lines
99+
- Default ports and query settings
100+
- Steam integration (App ID, anonymous login settings)
101+
- File management templates
102+
- Default scripts and variables
103+
104+
### Docker Blueprints
105+
106+
Docker plugins contain container configurations including:
107+
- Image name and registry settings
108+
- Port mappings
109+
- Volume mounts
110+
- Environment variables
111+
- Resource limits
112+
113+
### Scripts
114+
115+
Script plugins can be:
116+
- **Game Scripts** - Scripts that run for game server events
117+
- **Docker Scripts** - Scripts that run for Docker container events
118+
- **Script Modules** - Reusable script libraries
119+
120+
### Themes
121+
122+
Theme plugins customize the control panel appearance with custom CSS and styling.
123+
124+
### Languages
125+
126+
Language plugins add translations for the control panel interface.

‎versioned_docs/version-3/getting-started/initial-configuration/windows-autologon.mdx‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
sidebar_position: 5
3+
sidebar_label: Windows Auto-Logon
4+
---
5+
6+
# Windows Auto-Logon
7+
8+
Some game servers require the "Interact with Desktop" option to be enabled, which requires a user to be logged in to Windows. TCAdmin provides commands to configure Windows auto-logon securely.
9+
10+
:::info Windows Only
11+
This feature is only available on Windows servers.
12+
:::
13+
14+
## Why Auto-Logon?
15+
16+
When a game server is configured with "Interact with Desktop" enabled, it needs access to the Windows desktop session. For these games to start automatically when the server boots, a user must be logged in. Auto-logon ensures a user session is available after every restart.
17+
18+
## Enable Auto-Logon
19+
20+
Open **PowerShell** or **Command Prompt** as Administrator and run:
21+
22+
```powershell
23+
tca enable-autologon
24+
```
25+
26+
You will be prompted to enter:
27+
28+
1. **Username** - The Windows user account to log in automatically
29+
2. **Password** - The password for the account (entered securely, confirmed twice)
30+
3. **Domain** - The domain name (defaults to local computer name)
31+
32+
The command will verify the credentials before enabling auto-logon.
33+
34+
### Command Options
35+
36+
You can also provide credentials directly:
37+
38+
```powershell
39+
tca enable-autologon --username Administrator --password YourPassword --domain COMPUTERNAME
40+
```
41+
42+
| Option | Alias | Description |
43+
|--------|-------|-------------|
44+
| `--username` | `-u` | Username for auto-logon |
45+
| `--password` | `-p` | Password for auto-logon |
46+
| `--domain` | `-d` | Domain name (defaults to local computer) |
47+
| `--force` | `-f` | Force auto-logon (ignore Shift key bypass) |
48+
49+
:::tip Security
50+
The password is stored securely using Windows LSA Secrets (encrypted), similar to the Sysinternals Autologon tool. The password is not stored in plain text in the registry.
51+
:::
52+
53+
## Disable Auto-Logon
54+
55+
To disable auto-logon and remove stored credentials:
56+
57+
```powershell
58+
tca disable-autologon
59+
```
60+
61+
You will be asked to confirm before disabling. To skip the confirmation:
62+
63+
```powershell
64+
tca disable-autologon --yes
65+
```
66+
67+
This removes all stored passwords and disables automatic login.

‎versioned_docs/version-3/intro.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ slug: /
55

66
# TCAdmin v3 Documentation
77

8-
:::info Coming Soon
8+
:::info Work in Progress
99
The documentation for TCAdmin v3 is currently in development.
1010
:::
1111

12-
## What's New in v3
12+
## v3 Preview
1313

14-
Documentation for the new features and improvements in TCAdmin v3 will be available here soon.
14+
You can preview TCAdmin v3 using your existing v2 master license on the same server. This allows you to explore the new features and interface before the official release.
1515

16-
## In the Meantime
16+
## What's New in v3
1717

18-
For comprehensive TCAdmin documentation, please visit the [v2 documentation](/).
18+
Documentation for the new features and improvements in TCAdmin v3 will be available here soon.
1919

2020
---
2121

‎versioned_docs/version-3/update-tcadmin.mdx‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
sidebar_position: 9
3+
sidebar_label: Update TCAdmin
4+
---
5+
6+
import Tabs from "@theme/Tabs";
7+
import TabItem from "@theme/TabItem";
8+
9+
# Update TCAdmin
10+
11+
TCAdmin can be updated using the TCAdmin CLI tool. The update process will download and install the latest version while preserving your configuration.
12+
13+
## Update Command
14+
15+
<Tabs>
16+
<TabItem value="windows" label="Windows">
17+
18+
Open **PowerShell** or **Command Prompt** as Administrator and run:
19+
20+
```powershell
21+
tca update
22+
```
23+
24+
If `tca` is not in your PATH, navigate to the CLI directory first:
25+
26+
```powershell
27+
cd "C:\Program Files\TCAdmin3\cli"
28+
.\tca update
29+
```
30+
31+
</TabItem>
32+
<TabItem value="linux" label="Linux">
33+
34+
Open a terminal and run:
35+
36+
```bash
37+
./tca update
38+
```
39+
40+
If `tca` is not in your PATH, navigate to the CLI directory first:
41+
42+
```bash
43+
cd /opt/tcadmin3/cli
44+
./tca update
45+
```
46+
47+
</TabItem>
48+
</Tabs>
49+
50+
## What Happens During Update
51+
52+
The update process will:
53+
54+
1. Stop the TCAdmin services (Monitor and Web)
55+
2. Download the latest version
56+
3. Extract and install the update files
57+
4. Apply any database migrations
58+
5. Restart the TCAdmin services
59+
60+
## After Updating
61+
62+
After the update completes, verify that the services are running:
63+
64+
<Tabs>
65+
<TabItem value="windows" label="Windows">
66+
67+
```powershell
68+
Get-Service TCA3Monitor, TCA3Web
69+
```
70+
71+
</TabItem>
72+
<TabItem value="linux" label="Linux">
73+
74+
```bash
75+
sudo systemctl status tca3monitor tca3web
76+
```
77+
78+
</TabItem>
79+
</Tabs>

0 commit comments

Comments
 (0)