Termix

https://docs.termix.site/
Admin
Termix is a clientless web-based server management platform with SSH terminal, tunneling, and file...
Tokens:25,763
Snippets:384
Trust Score:6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Docker Run Commands

Source: https://docs.termix.site/install/server/docker

Manual setup using the docker CLI to create a volume and start the container.

```bash
# Step 1: Create the volume  
docker volume create termix-data  
  
# Step 2: Run the container  
docker run -d \
  --name termix \
  --restart unless-stopped \
  -p 8080:8080 \
  -v termix-data:/app/data \
  -e PORT=8080 \
  ghcr.io/lukegus/termix:latest  
```

--------------------------------

### Install dependencies and build the project

Source: https://docs.termix.site/install/server/manual

Commands to install required Node.js packages and compile the application.

```bash
npm install  

npm run build  
```

--------------------------------

### Install dependencies

Source: https://docs.termix.site/contributing

Install all required project dependencies using NPM.

```bash
npm install
```

--------------------------------

### Start the application

Source: https://docs.termix.site/install/server/manual

Command to launch the application in preview mode.

```bash
npm run preview  
```

--------------------------------

### Install dependencies for building

Source: https://docs.termix.site/install/server/manual

Install project dependencies specifically for the build process.

```bash
npm install  
```

--------------------------------

### Start the backend services

Source: https://docs.termix.site/install/server/manual

Command to initiate the backend development services.

```bash
npm run dev:backend  
```

--------------------------------

### Retrieve credential folders with C#

Source: https://docs.termix.site/api/get-credential-folders

Example using HttpClient to perform a GET request with bearer token authorization.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:30001/credentials/folders");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Install via AUR

Source: https://docs.termix.site/install/connector/linux

Install the Termix binary package using the yay AUR helper.

```bash
yay -S termix-bin  
```

--------------------------------

### Install Termix via Flatpak

Source: https://docs.termix.site/install/connector/linux

Download and install the Termix Flatpak package using the command line.

```bash
wget https://github.com/Termix-SSH/Termix/releases/latest/download/termix_linux_flatpak.flatpak  

flatpak install --user termix_linux_flatpak.flatpak  
```

--------------------------------

### Start development server

Source: https://docs.termix.site/contributing

Launch the local development server to preview documentation changes.

```bash
npm run start
```

--------------------------------

### Get hosts using a credential in C#

Source: https://docs.termix.site/api/get-hosts-using-a-credential

Example implementation using HttpClient to retrieve hosts associated with a credential.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:30001/credentials/:id/hosts");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

--------------------------------

### Start Termix Executable

Source: https://docs.termix.site/install/connector/linux

Launch the application using the no-sandbox flag; do not run with sudo.

```bash
./termix --no-sandbox
```

--------------------------------

### Fetch dismissed alerts with HttpClient

Source: https://docs.termix.site/api/get-dismissed-alerts

Example usage of the C# HttpClient to perform the GET request with an authorization header.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:30001/alerts/dismissed");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Install Termix via Homebrew

Source: https://docs.termix.site/install/connector/macos

Use these commands to add the custom tap and install the Termix cask.

```bash
brew tap Termix-SSH/Termix https://github.com/Termix-SSH/Termix.git  

brew install --cask termix  
```

--------------------------------

### Beta Build Image Reference

Source: https://docs.termix.site/install/server/docker

Example of referencing the unstable beta build tag in configurations.

```text
ghcr.io/lukegus/termix:beta  
```

--------------------------------

### Retrieve credentials using C# HttpClient

Source: https://docs.termix.site/api/get-all-credentials

Example implementation using the C# HttpClient library to perform the GET request with bearer authentication.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:30001/credentials");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Install Docker Engine

Source: https://docs.termix.site/install/ginernet

Configures the official Docker repository and installs the Docker engine components on Debian-based systems.

```bash
# Add Docker's official GPG key:  

sudo apt update  

sudo apt install ca-certificates curl  

sudo install -m 0755 -d /etc/apt/keyrings  

sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc  

sudo chmod a+r /etc/apt/keyrings/docker.asc  

  

# Add the repository to Apt sources:  

sudo tee /etc/apt/sources.list.d/docker.sources <<EOF  

Types: deb  

URIs: https://download.docker.com/linux/debian  

Suites: $(. /etc/os-release && echo "$VERSION_CODENAME")  

Components: stable  

Architectures: $(dpkg --print-architecture)  

Signed-By: /etc/apt/keyrings/docker.asc  

EOF  

  

sudo apt update  
```

```bash
sudo apt install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin  
```

--------------------------------

### Retrieve network topology using C# HttpClient

Source: https://docs.termix.site/api/get-network-topology

Example implementation using C# HttpClient to perform the GET request with bearer token authorization.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:30001/network-topology");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Request Body Example

Source: https://docs.termix.site/api/create-a-new-credential

A sample JSON body for the credential creation request.

```json
{
  "name": "string",
  "description": "string",
  "folder": "string",
  "tags": [
    "string"
  ],
  "authType": "password",
  "username": "string",
  "password": "string",
  "key": "string",
  "keyPassword": "string",
  "keyType": "string"
}
```

--------------------------------

### Install or Update Termix on Proxmox VE

Source: https://docs.termix.site/install/server/proxmox

Executes the installation script directly from the community-scripts repository.

```bash
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/termix.sh)"
```

--------------------------------

### Share Host C# Implementation

Source: https://docs.termix.site/api/share-a-host

Example implementation using HttpClient to perform the share host request.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:30001/rbac/host/:id/share");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"targetType\": \"user\",\n  \"targetUserId\": \"string\",\n  \"targetRoleId\": 0,\n  \"durationHours\": 0,\n  \"permissionLevel\": \"view\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Request Body Example

Source: https://docs.termix.site/api/generate-new-ssh-key-pair

A sample JSON payload for the request body.

```json
{
  "keyType": "string",
  "keySize": 0,
  "passphrase": "string"
}
```

--------------------------------

### C# HttpClient Implementation

Source: https://docs.termix.site/api/generate-new-ssh-key-pair

Example implementation using C# HttpClient to send the POST request.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:30001/credentials/generate-key-pair");  
request.Headers.Add("Authorization", "Bearer <token>");  
var content = new StringContent("{\n  \"keyType\": \"string\",\n  \"keySize\": 0,\n  \"passphrase\": \"string\"\n}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

--------------------------------

### C# HttpClient Implementation

Source: https://docs.termix.site/api/create-a-new-credential

Example implementation using C# HttpClient to send the POST request.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:30001/credentials");  
request.Headers.Add("Authorization", "Bearer <token>");  
var content = new StringContent("{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"folder\": \"string\",\n  \"tags\": [\n    \"string\"\n  ],\n  \"authType\": \"password\",\n  \"username\": \"string\",\n  \"password\": \"string\",\n  \"key\": \"string\",\n  \"keyPassword\": \"string\",\n  \"keyType\": \"string\"\n}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

--------------------------------

### Install Custom Certificates

Source: https://docs.termix.site/features/networking/ssl

Copies existing certificate files into the Termix data directory and sets appropriate file permissions.

```bash
cp /path/to/fullchain.pem ./db/data/ssl/termix.crt  

cp /path/to/privkey.pem   ./db/data/ssl/termix.key  

  

chmod 600 ./db/data/ssl/termix.key  

chmod 644 ./db/data/ssl/termix.crt
```

--------------------------------

### Start the Docker container

Source: https://docs.termix.site/install/server/manual

Launch the services defined in the Docker Compose file in detached mode.

```bash
docker-compose up -d  
```

--------------------------------

### Authenticate with API Key

Source: https://docs.termix.site/features/api/api-keys

Examples of how to include the API key in the Authorization header for various environments.

```curl
curl -H "Authorization: Bearer tmx_your_token_here" http://your-termix-url/host/db/hosts
```

```powershell
Invoke-RestMethod -Uri "http://your-termix-url/host/db/hosts" `  

  -Headers @{ "Authorization" = "Bearer tmx_your_token_here" }
```

```javascript
fetch("http://your-termix-url/host/db/hosts", {  

  headers: { Authorization: "Bearer tmx_your_token_here" }  

})
```

--------------------------------

### Define Proxy and Host Configurations

Source: https://docs.termix.site/features/files-and-hosts/json-import

Examples of JSON objects for configuring SOCKS5 proxy settings, multi-hop proxy chains, and customized terminal server environments.

```json
"socks5Host": "proxy.example.com",  

      "socks5Port": 1080,  

      "socks5Username": "proxyauth",  

      "socks5Password": "proxypass"  

    },  

    {  

      "name": "Server Behind Proxy Chain",  

      "ip": "172.16.0.50",  

      "port": 22,  

      "username": "chainuser",  

      "authType": "key",  

      "key": "-----BEGIN OPENSSH PRIVATE KEY-----\nYour SSH private key content here\n-----END OPENSSH PRIVATE KEY-----",  

      "folder": "Proxied Hosts",  

      "tags": ["proxy-chain", "multi-hop"],  

      "notes": "Requires multi-hop proxy chain to access.",  

      "useSocks5": true,  

      "socks5ProxyChain": [  

        {  

          "host": "proxy1.example.com",  

          "port": 1080,  

          "type": 5,  

          "username": "proxy1user",  

          "password": "proxy1pass"  

        },  

        {  

          "host": "proxy2.internal.net",  

          "port": 1080,  

          "type": 5,  

          "username": "proxy2user",  

          "password": "proxy2pass"  

        },  

        {  

          "host": "proxy3.secure.local",  

          "port": 9050,  

          "type": 4  

        }  

      ]  

    },  

    {  

      "name": "Customized Terminal Server",  

      "ip": "192.168.1.150",  

      "port": 22,  

      "username": "devops",  

      "authType": "password",  

      "password": "terminal_password",  

      "folder": "Development",  

      "tags": ["custom", "terminal"],  

      "notes": "Server with custom terminal configuration and startup scripts.",  

      "enableTerminal": true,  

      "terminalConfig": {  

        "cursorBlink": true,  

        "cursorStyle": "bar",  

        "fontSize": 16,  

        "fontFamily": "jetbrainsMono",  

        "letterSpacing": 0.5,  

        "lineHeight": 1.2,  

        "theme": "monokai",  

        "scrollback": 50000,  

        "bellStyle": "visual",  

        "rightClickSelectsWord": true,  

        "fastScrollModifier": "ctrl",  

        "fastScrollSensitivity": 7,  

        "minimumContrastRatio": 4,  

        "backspaceMode": "normal",  

        "agentForwarding": true,  

        "environmentVariables": [  

          {  

            "key": "NODE_ENV",  

            "value": "development"  

          },  

          {  

            "key": "API_URL",  

            "value": "https://api.dev.example.com"  

          }  

        ],  

        "startupSnippetId": 3,  

        "autoMosh": true,  

        "moshCommand": "mosh --server=/usr/local/bin/mosh-server",  

        "sudoPasswordAutoFill": true,  

        "sudoPassword": "sudo_password_here"  

      }  

    }
```

--------------------------------

### C# HttpClient Request

Source: https://docs.termix.site/api/generate-public-key-from-private-key

Example implementation using C# HttpClient to send the request.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:30001/credentials/generate-public-key");  
request.Headers.Add("Authorization", "Bearer <token>");  
var content = new StringContent("{\n  \"privateKey\": \"string\",\n  \"keyPassword\": \"string\"\n}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

--------------------------------

### Deploy SSH Key using C# HttpClient

Source: https://docs.termix.site/api/deploy-ssh-key-to-a-host

Example implementation using the C# HttpClient library to perform the POST request.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:30001/credentials/:id/deploy-to-host");  
request.Headers.Add("Authorization", "Bearer <token>");  
var content = new StringContent("{\n  \"targetHostId\": 0\n}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### C# HttpClient request

Source: https://docs.termix.site/api/get-a-specific-credential

Example of fetching a credential using the C# HttpClient library.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:30001/credentials/:id");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

--------------------------------

### Define Host Configurations in JSON

Source: https://docs.termix.site/features/files-and-hosts/json-import

The import file must be a JSON object containing a "hosts" array, or an array of host objects directly. This example demonstrates various configurations including password, key, and credential-based authentication.

```json
{

  "hosts": [

    {

      "name": "Web Server - Production",

      "ip": "192.168.1.100",

      "port": 22,

      "username": "admin",

      "authType": "password",

      "password": "your_secure_password_here",

      "folder": "Production",

      "tags": ["web", "production", "nginx"],

      "pin": true,

      "notes": "Main production web server running Nginx. Contact ops@company.com for access.",

      "enableTerminal": true,

      "enableTunnel": false,

      "enableFileManager": true,

      "enableDocker": false,

      "showTerminalInSidebar": true,

      "showFileManagerInSidebar": true,

      "showServerStatsInSidebar": true,

      "defaultPath": "/var/www"

    },

    {

      "name": "Database Server",

      "ip": "192.168.1.101",

      "port": 22,

      "username": "dbadmin",

      "authType": "key",

      "key": "-----BEGIN OPENSSH PRIVATE KEY-----\nYour SSH private key content here\n-----END OPENSSH PRIVATE KEY-----",

      "keyPassword": "optional_key_passphrase",

      "keyType": "ssh-ed25519",

      "folder": "Production",

      "tags": ["database", "production", "postgresql"],

      "pin": false,

      "notes": "PostgreSQL production database. Requires VPN access.",

      "enableTerminal": true,

      "enableTunnel": true,

      "enableFileManager": false,

      "enableDocker": false,

      "showTerminalInSidebar": true,

      "showTunnelInSidebar": true,

      "showServerStatsInSidebar": true,

      "tunnelConnections": [

        {

          "sourcePort": 5432,

          "endpointPort": 5432,

          "endpointHost": "Web Server - Production",

          "maxRetries": 3,

          "retryInterval": 10,

          "autoStart": true

        }

      ],

      "statsConfig": {

        "enabledWidgets": ["cpu", "memory", "disk", "network", "uptime"],

        "statusCheckEnabled": true,

        "statusCheckInterval": 30,

        "metricsEnabled": true,

        "metricsInterval": 30

      }

    },

    {

      "name": "Development Server",

      "ip": "192.168.1.102",

      "port": 2222,

      "username": "developer",

      "authType": "credential",

      "credentialId": 1,

      "overrideCredentialUsername": false,

      "folder": "Development",

      "tags": ["dev", "testing"],

      "pin": false,

      "notes": "Development environment for testing new features.",

      "enableTerminal": true,

      "enableTunnel": false,

      "enableFileManager": true,

      "enableDocker": true,

      "showTerminalInSidebar": true,

      "showFileManagerInSidebar": true,

      "showDockerInSidebar": true,

      "defaultPath": "/home/developer",

      "sudoPassword": "dev_sudo_password"

    },

    {

      "name": "Private Network Server",

      "ip": "10.0.0.50",

      "port": 22,

      "username": "sysadmin",

      "authType": "password",

      "password": "secure_password",

      "folder": "Infrastructure",

      "tags": ["bastion", "jump-host"],

      "notes": "Jump host for accessing internal network servers.",

      "enableTerminal": true,

      "enableTunnel": true,

      "enableFileManager": true,

      "jumpHosts": [

        {

          "hostId": 1

        }

      ],

      "quickActions": [

        {

          "name": "System Update",

          "snippetId": 5

        },

        {

          "name": "Check Disk Space",

          "snippetId": 12

        }

      ]

    },

    {

      "name": "Certificate-Based Server",

      "ip": "192.168.1.200",

      "port": 22,

      "username": "certuser",

      "authType": "none",

      "folder": "Secure Hosts",

      "tags": ["cert-auth", "secure"],

      "notes": "Uses certificate-based authentication. Cert must be installed in SSH agent.",

      "enableTerminal": true,

      "enableTunnel": false,

      "enableFileManager": false,

      "forceKeyboardInteractive": false

    },

    {

      "name": "Server Behind Single Proxy",

      "ip": "10.10.10.100",

      "port": 22,

      "username": "proxyuser",

      "authType": "password",

      "password": "secure_password",

      "folder": "Proxied Hosts",

      "tags": ["proxy", "socks5"],

      "notes": "Accessible through corporate SOCKS5 proxy.",

      "useSocks5": true,
```

--------------------------------

### Save network topology using HttpClient

Source: https://docs.termix.site/api/save-network-topology

Example implementation in C# using HttpClient to send the topology data.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:30001/network-topology");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"topology\": {}\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### GET http://localhost:30001/credentials/folders

Source: https://docs.termix.site/api/get-credential-folders

Retrieves all unique credential folders for the authenticated user.

```APIDOC
## GET http://localhost:30001/credentials/folders

### Description
Retrieves all unique credential folders for the authenticated user.

### Method
GET

### Endpoint
http://localhost:30001/credentials/folders

### Authorization
- **Type**: http
- **Scheme**: bearer
- **BearerFormat**: JWT

### Response
#### Success Response (200)
- A list of folder names.

#### Error Responses
- **400**: Invalid userId.
- **500**: Failed to fetch credential folders.
```

--------------------------------

### Apply credential to host using C# HttpClient

Source: https://docs.termix.site/api/apply-a-credential-to-a-host

Example implementation using C# HttpClient to send a POST request with bearer authentication.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:30001/credentials/:id/apply-to-host/:hostId");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Authelia OIDC configuration

Source: https://docs.termix.site/features/authentication/oidc

Example configuration for setting up Termix as an OIDC client within Authelia.

```yaml
identity_providers:  
  oidc:  
    claims_policies:  
      legacy:  
        id_token: ['email', 'email_verified', 'preferred_username', 'name']  
  
    authorization_policies:  
      termix:  
        default_policy: deny  
        rules:  
          - policy: one_factor  
            subject: group:termix  
  
    clients:  
      - client_id: termix  
        client_secret: client_secret_here  
        public: false  
        authorization_policy: termix  
        consent_mode: implicit  
        claims_policy: legacy  
        grant_types:  
          - authorization_code  
        response_types:  
          - code  
        scopes:  
          - openid  
          - profile  
          - email  
        redirect_uris:  
          - https://termix.{your-domain}/users/oidc/callback  
        token_endpoint_auth_method: client_secret_post
```

--------------------------------

### Manage Flatpak Application

Source: https://docs.termix.site/install/connector/linux

Commands to start, update, or uninstall the Termix Flatpak application.

```bash
flatpak run com.karmaa.termix  
```

```bash
flatpak update com.karmaa.termix  
```

```bash
flatpak uninstall com.karmaa.termix  
```

--------------------------------

### Get credential folders endpoint

Source: https://docs.termix.site/api/get-credential-folders

The base endpoint for retrieving credential folders.

```http
GET 
## http://localhost:30001/credentials/folders
```

--------------------------------

### API Request Body Example

Source: https://docs.termix.site/api/detect-ssh-key-type

The JSON payload structure for the API request.

```json
{
  "privateKey": "string",
  "keyPassword": "string"
}
```

--------------------------------

### Update credential using HttpClient

Source: https://docs.termix.site/api/update-a-credential

Example implementation using C# HttpClient to perform the PUT request.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Put, "http://localhost:30001/credentials/:id");  
request.Headers.Add("Authorization", "Bearer <token>");  
var content = new StringContent("{\n  \"name\": \"string\",\n  \"description\": \"string\"\n}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Detect public key type with HttpClient

Source: https://docs.termix.site/api/detect-ssh-public-key-type

Example implementation using C# HttpClient to send the detection request.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:30001/credentials/detect-public-key-type");  
request.Headers.Add("Authorization", "Bearer <token>");  
var content = new StringContent("{\n  \"publicKey\": \"string\"\n}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Configure Termix with SSL in Docker Compose

Source: https://docs.termix.site/features/networking/ssl

Example configuration for running Termix with SSL enabled using Docker Compose. Ensure the SSL ports are mapped and environment variables are set correctly.

```yaml
services:  

  termix:  

    image: ghcr.io/lukegus/termix:latest  

    container_name: termix  

    restart: unless-stopped  

    ports:  

      - "8080:8080"  

      - "8443:8443"  

    volumes:  

      - termix-data:/app/data  

    environment:  

      PORT: "8080"  

      ENABLE_SSL: "true"  

      SSL_PORT: "8443"  

      SSL_DOMAIN: "termix.example.com"  

      GUACD_HOST: "guacd"  

    depends_on:  

      - guacd  

  

  guacd:  

    image: guacamole/guacd:1.6.0  

    container_name: guacd  

    restart: unless-stopped  

  

volumes:  

  termix-data:  
```

--------------------------------

### Configure OPKSSH Provider

Source: https://docs.termix.site/features/authentication/opkssh

Example configuration for an OAuth provider in the config.yml file. Ensure the client_id and client_secret are updated with your specific credentials.

```yaml
providers:  

  - alias: google  

    issuer: https://accounts.google.com  

    client_id: YOUR_CLIENT_ID  

    client_secret: YOUR_CLIENT_SECRET  

    scopes: openid email profile  

    access_type: offline  

    prompt: consent  
```

--------------------------------

### Rename credential folder using HttpClient

Source: https://docs.termix.site/api/rename-a-credential-folder

Example implementation using C# HttpClient to perform the rename operation.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Put, "http://localhost:30001/credentials/folders/rename");  
request.Headers.Add("Authorization", "Bearer <token>");  
var content = new StringContent("{\n  \"oldName\": \"string\",\n  \"newName\": \"string\"\n}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Configure guacd service URL

Source: https://docs.termix.site/setup/remote-desktop

Examples of URLs to input into the Termix Admin settings based on the deployment method.

```text
guacd:4822
```

```text
localhost:4822
```

--------------------------------

### Install guacd via Docker

Source: https://docs.termix.site/setup/remote-desktop

Run the official guacd container. Ensure the container is reachable by the Termix instance via Docker networks.

```bash
docker run --name some-guacd -d guacamole/guacd
```

--------------------------------

### Dismiss Alert via HttpClient

Source: https://docs.termix.site/api/dismiss-an-alert

Example implementation using C# HttpClient to send the dismissal request.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:30001/alerts/dismiss");  
request.Headers.Add("Authorization", "Bearer <token>");  
var content = new StringContent("{\n  \"alertId\": \"string\"\n}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### C# HttpClient validation request

Source: https://docs.termix.site/api/validate-ssh-key-pair

Example implementation using C# HttpClient to send a validation request.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:30001/credentials/validate-key-pair");  
request.Headers.Add("Authorization", "Bearer <token>");  
var content = new StringContent("{\n  \"privateKey\": \"string\",\n  \"publicKey\": \"string\",\n  \"keyPassword\": \"string\"\n}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

--------------------------------

### Detect SSH Key Type with C# HttpClient

Source: https://docs.termix.site/api/detect-ssh-key-type

Example implementation using C# HttpClient to send the detection request.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:30001/credentials/detect-key-type");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"privateKey\": \"string\",\n  \"keyPassword\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Delete Credential using C# HttpClient

Source: https://docs.termix.site/api/delete-a-credential

Example implementation for deleting a credential using the C# HttpClient library.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Delete, "http://localhost:30001/credentials/:id");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Undismiss Alert using C# HttpClient

Source: https://docs.termix.site/api/undismiss-an-alert

Example implementation for undismissing an alert using the C# HttpClient library.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Delete, "https://docs.termix.site/alerts/dismiss");  
request.Headers.Add("Authorization", "Bearer <token>");  
var content = new StringContent(string.Empty);  
content.Headers.ContentType = new MediaTypeHeaderValue("application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Manage Termix via Chocolatey

Source: https://docs.termix.site/install/connector/windows

Commands to install, upgrade, or remove the Termix SSH package using the Chocolatey CLI.

```powershell
choco install termix-ssh
```

```powershell
choco upgrade termix-ssh
```

```powershell
choco uninstall termix-ssh
```

--------------------------------

### Build the frontend

Source: https://docs.termix.site/install/server/manual

Compile the frontend assets.

```bash
npm run build  
```

--------------------------------

### Clone the repository

Source: https://docs.termix.site/contributing

Initial step to download the project source code to your local machine.

```bash
git clone https://github.com/Termix-SSH/Docs
```

--------------------------------

### Build the Docker image

Source: https://docs.termix.site/install/server/manual

Create a local Docker image using the provided Dockerfile.

```bash
docker build -t termix:latest -f docker/Dockerfile .  
```

--------------------------------

### Retrieve credential via HTTP GET

Source: https://docs.termix.site/api/get-a-specific-credential

The endpoint requires a GET request to the specified URL with the credential ID.

```http
GET 
## http://localhost:30001/credentials/:id
```

--------------------------------

### Deploy Termix with Docker Compose

Source: https://docs.termix.site/install/ginernet

Downloads the Termix configuration file and initializes the container environment.

```bash
mkdir -p ~/termix  

cd ~/termix  

curl -fsSL -o docker-compose.yml https://raw.githubusercontent.com/Termix-SSH/Termix/refs/heads/main/docker/docker-compose.yml  
```

```bash
sudo docker compose up -d  
```

--------------------------------

### GET http://localhost:30001/network-topology

Source: https://docs.termix.site/api/get-network-topology

Retrieves the network topology for the authenticated user.

```APIDOC
## GET http://localhost:30001/network-topology

### Description
Retrieves the network topology for the authenticated user.

### Method
GET

### Endpoint
http://localhost:30001/network-topology

### Authorization
- **Type**: http
- **Scheme**: bearer
- **BearerFormat**: JWT

### Response
#### Success Response (200)
- The network topology.

#### Error Responses
- **401**: User not authenticated.
- **500**: Failed to fetch network topology.
```

--------------------------------

### GET /alerts Endpoint

Source: https://docs.termix.site/api/get-active-alerts

The base endpoint for retrieving active alerts.

```http
GET 
## http://localhost:30001/alerts
```

--------------------------------

### GET http://localhost:30001/credentials

Source: https://docs.termix.site/api/get-all-credentials

Retrieves all SSH credentials for the authenticated user.

```APIDOC
## GET http://localhost:30001/credentials

### Description
Retrieves all SSH credentials for the authenticated user.

### Method
GET

### Endpoint
http://localhost:30001/credentials

### Authorization
- **Type**: http
- **Scheme**: bearer
- **BearerFormat**: JWT

### Response
#### Success Response (200)
- A list of credentials.

#### Error Responses
- 400: Invalid userId.
- 500: Failed to fetch credentials.
```

--------------------------------

### GET http://localhost:30001/alerts/dismissed

Source: https://docs.termix.site/api/get-dismissed-alerts

Fetches a list of alerts that have been dismissed by the authenticated user.

```APIDOC
## GET http://localhost:30001/alerts/dismissed

### Description
Fetches a list of alerts that have been dismissed by the authenticated user.

### Method
GET

### Endpoint
http://localhost:30001/alerts/dismissed

### Authorization
- **Type**: http
- **Scheme**: bearer
- **Bearer Format**: JWT

### Response
#### Success Response (200)
- A list of dismissed alerts.

#### Error Response (500)
- Failed to fetch dismissed alerts.
```

--------------------------------

### Create a new user

Source: https://docs.termix.site/install/ginernet

Command to add a new user to the system.

```bash
adduser termix  
```

--------------------------------

### GET /credentials/:id/hosts

Source: https://docs.termix.site/api/get-hosts-using-a-credential

Retrieves a list of hosts that are using a specific credential.

```APIDOC
## GET /credentials/:id/hosts

### Description
Retrieves a list of hosts that are using a specific credential.

### Method
GET

### Endpoint
http://localhost:30001/credentials/:id/hosts

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the credential.

### Response
#### Success Response (200)
- A list of hosts.

#### Error Responses
- **400**: Invalid request.
- **500**: Failed to fetch hosts using credential.
```

--------------------------------

### Get dismissed alerts endpoint

Source: https://docs.termix.site/api/get-dismissed-alerts

The endpoint path for retrieving dismissed alerts.

```http
GET 
## http://localhost:30001/alerts/dismissed
```

--------------------------------

### GET http://localhost:30001/credentials/:id

Source: https://docs.termix.site/api/get-a-specific-credential

Retrieves a specific credential by its ID, including secrets.

```APIDOC
## GET http://localhost:30001/credentials/:id

### Description
Retrieves a specific credential by its ID, including secrets.

### Method
GET

### Endpoint
http://localhost:30001/credentials/:id

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the credential.

### Response
#### Success Response (200)
- The requested credential.

#### Error Responses
- **400**: Invalid request.
- **404**: Credential not found.
- **500**: Failed to fetch credential.
```

--------------------------------

### GET http://localhost:30001/alerts

Source: https://docs.termix.site/api/get-active-alerts

Fetches active alerts for the authenticated user, excluding those that have been dismissed.

```APIDOC
## GET http://localhost:30001/alerts

### Description
Fetches active alerts for the authenticated user, excluding those that have been dismissed.

### Method
GET

### Endpoint
http://localhost:30001/alerts

### Authorization
- **Type**: http
- **Scheme**: bearer
- **Bearer Format**: JWT

### Response
#### Success Response (200)
- A list of active alerts.

#### Error Response (500)
- Failed to fetch alerts.
```

--------------------------------

### Enable SSL Environment Variables

Source: https://docs.termix.site/features/networking/ssl

Configures the environment variables required to enable and customize SSL settings.

```bash
ENABLE_SSL=true  

SSL_PORT=8443  

SSL_DOMAIN=termix.example.com
```

--------------------------------

### Configure SSL Environment Variables

Source: https://docs.termix.site/features/networking/ssl

Set these environment variables to enable SSL and define the certificate domain and port after issuance.

```yaml
environment:  

  ENABLE_SSL: "true"  

  SSL_PORT: "8443"  

  SSL_DOMAIN: "termix.example.com"  
```

--------------------------------

### Enable Tailscale SSH on Server

Source: https://docs.termix.site/features/networking/tailscale

Run this command on the target server to enable Tailscale SSH, allowing Termix to connect without traditional SSH credentials.

```bash
tailscale set --ssh
```

--------------------------------

### Generate Self-Signed Development Certificates

Source: https://docs.termix.site/features/networking/ssl

Creates a private key and a self-signed certificate for local development environments.

```bash
mkdir -p ./db/data/ssl  

  

openssl genrsa -out ./db/data/ssl/termix.key 2048  

  

openssl req -new -x509 \  

  -key ./db/data/ssl/termix.key \  

  -out ./db/data/ssl/termix.crt \  

  -days 365 \  

  -subj "/C=US/ST=State/L=City/O=Termix/CN=localhost" \  

  -addext "subjectAltName=DNS:localhost,IP:127.0.0.1"  

  

chmod 600 ./db/data/ssl/termix.key  

chmod 644 ./db/data/ssl/termix.crt
```

--------------------------------

### Clone the Termix repository

Source: https://docs.termix.site/install/server/manual

Initial step to download the source code from GitHub.

```bash
git clone https://github.com/Termix-SSH/Termix.git  

cd Termix  
```

--------------------------------

### POST /credentials/:id/deploy-to-host

Source: https://docs.termix.site/api/deploy-ssh-key-to-a-host

Deploys an SSH public key to a target host's authorized_keys file.

```APIDOC
## POST /credentials/:id/deploy-to-host

### Description
Deploys an SSH public key to a target host's authorized_keys file.

### Method
POST

### Endpoint
http://localhost:30001/credentials/:id/deploy-to-host

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the credential to deploy.

#### Request Body
- **targetHostId** (integer) - Required - The ID of the target host.

### Request Example
{
  "targetHostId": 0
}

### Response
#### Success Response (200)
- SSH key deployed successfully.

#### Error Responses
- 400: Credential ID and target host ID are required.
- 401: Authentication required.
- 404: Credential or target host not found.
- 500: Failed to deploy SSH key.
```

--------------------------------

### Create a new branch

Source: https://docs.termix.site/contributing

Create and switch to a new feature branch for your changes.

```bash
git checkout -b feature/my-new-feature
```

--------------------------------

### Docker Compose with guacd

Source: https://docs.termix.site/install/server/docker

Recommended configuration for full functionality including remote desktop support.

```yaml
services:  

  termix:  

    image: ghcr.io/lukegus/termix:latest  

    container_name: termix  

    restart: unless-stopped  

    ports:  

      - '8080:8080'  

    volumes:  

      - termix-data:/app/data  

    environment:  

      PORT: '8080'  

    depends_on:  

      - guacd  

    networks:  

      - termix-net  

  

  guacd:  

    image: guacamole/guacd:1.6.0  

    container_name: guacd  

    restart: unless-stopped  

    ports:  

      - "4822:4822"  

    networks:  

      - termix-net  

  

volumes:  

  termix-data:  

    driver: local  

  

networks:  

  termix-net:  

    driver: bridge  
```

--------------------------------

### Configure Base Path

Source: https://docs.termix.site/setup/reverse-proxy

Environment variable configuration to change the base path of the application.

```text
VITE_BASE_PATH=/termix/  

  

http://localhost:8080/termix/  
```

--------------------------------

### Get hosts using a credential endpoint definition

Source: https://docs.termix.site/api/get-hosts-using-a-credential

The base endpoint path for retrieving hosts associated with a specific credential ID.

```http
GET 
## http://localhost:30001/credentials/:id/hosts
```

--------------------------------

### POST /credentials/:id/apply-to-host/:hostId

Source: https://docs.termix.site/api/apply-a-credential-to-a-host

Applies a credential to an SSH host for quick application.

```APIDOC
## POST /credentials/:id/apply-to-host/:hostId

### Description
Applies a credential to an SSH host for quick application.

### Method
POST

### Endpoint
http://localhost:30001/credentials/:id/apply-to-host/:hostId

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the credential.
- **hostId** (integer) - Required - The ID of the host.

### Authorization
- **Type**: Bearer Token (JWT)

### Response
#### Success Response (200)
- Credential applied to host successfully.

#### Error Responses
- **400**: Invalid request.
- **404**: Credential not found.
- **500**: Failed to apply credential to host.
```

--------------------------------

### Configure Executable Permissions

Source: https://docs.termix.site/install/connector/linux

Set necessary file permissions for the Termix executable and sandbox.

```bash
chmod +x termix  

sudo chown root:root chrome-sandbox  

sudo chmod 4755 chrome-sandbox  
```

--------------------------------

### Provision a server with Termix ID

Source: https://docs.termix.site/features/authentication/termix-id

Appends the public keys from your Termix ID handle to the server's authorized_keys file. This is a one-time operation that requires root privileges.

```bash
curl -fsSL https://your-termix/termix-id/u/yourhandle >> ~/.ssh/authorized_keys
```

--------------------------------

### Define Remote Desktop and Network Connections

Source: https://docs.termix.site/features/files-and-hosts/json-import

JSON configurations for RDP, VNC, and Telnet connections, including Guacamole-specific settings.

```json
{
      "connectionType": "rdp",  

      "name": "Windows Server 2022",  

      "ip": "192.168.1.200",  

      "port": 3389,  

      "username": "Administrator",  

      "password": "windows_password",  

      "domain": "COMPANY",  

      "security": "nla",  

      "ignoreCert": false,  

      "folder": "Remote Desktop",  

      "tags": ["rdp", "windows", "production"],  

      "notes": "Production Windows Server with RDP access",  

      "guacamoleConfig": {  

        "enable-drive": true,  

        "drive-path": "/shared",  

        "create-drive-path": true,  

        "server-layout": "en-us-qwerty",  

        "resize-method": "display-update"  

      }  

    },  

    {  

      "connectionType": "vnc",  

      "name": "Ubuntu Desktop",  

      "ip": "192.168.1.201",  

      "port": 5900,  

      "username": "vncuser",  

      "password": "vnc_password",  

      "folder": "Remote Desktop",  

      "tags": ["vnc", "linux", "desktop"],  

      "notes": "Ubuntu desktop with VNC server",  

      "guacamoleConfig": {  

        "color-depth": 24,  

        "cursor": "remote",  

        "read-only": false,  

        "clipboard-encoding": "UTF-8"  

      }  

    },  

    {  

      "connectionType": "telnet",  

      "name": "Network Switch",  

      "ip": "192.168.1.254",  

      "port": 23,  

      "username": "admin",  

      "password": "switch_password",  

      "folder": "Infrastructure",  

      "tags": ["telnet", "network", "switch"],  

      "notes": "Legacy network switch with Telnet access",  

      "guacamoleConfig": {  

        "color-scheme": "green-black",  

        "font-name": "monospace",  

        "font-size": 12,  

        "scrollback": 1024,  

        "backspace": 127  

      }  

    }
```

--------------------------------

### Push changes to fork

Source: https://docs.termix.site/contributing

Upload your local commits to your remote fork.

```bash
git push origin feature/my-feature-request
```
Tokens:
Raw