feat: run cleanup and add reverse proxy docs

Author: LukeGus

.github/workflows/deploy.yml

@@ -34,4 +34,4 @@ jobs:
           remote_host: ${{ secrets.DEPLOY_HOST }}
           remote_user: ${{ secrets.DEPLOY_USER }}
           remote_key: ${{ secrets.DEPLOY_KEY }}
-          remote_port: ${{ secrets.DEPLOY_PORT }}
+          remote_port: ${{ secrets.DEPLOY_PORT }}

docs/install/server/docker.md

@@ -29,11 +29,11 @@ services:
     container_name: termix
     restart: unless-stopped
     ports:
-      - "8080:8080"
+      - '8080:8080'
     volumes:
       - termix-data:/app/data
     environment:
-      PORT: "8080"
+      PORT: '8080'
 
 volumes:
   termix-data:
@@ -69,11 +69,11 @@ services:
     container_name: termix
     restart: unless-stopped
     ports:
-      - "8080:8080"
+      - '8080:8080'
     volumes:
       - termix-data:/app/data
     environment:
-      PORT: "8080"
+      PORT: '8080'
 
 volumes:
   termix-data:

docs/install/server/manual.md

@@ -83,11 +83,11 @@ services:
     container_name: termix
     restart: unless-stopped
     ports:
-      - "8080:8080"
+      - '8080:8080'
     volumes:
       - termix-data:/app/data
     environment:
-      PORT: "8080"
+      PORT: '8080'
 
 volumes:
   termix-data:

docs/oidc.md

@@ -162,7 +162,7 @@ identity_providers:
   oidc:
     claims_policies:
       legacy:
-        id_token: ["email", "email_verified", "preferred_username", "name"]
+        id_token: ['email', 'email_verified', 'preferred_username', 'name']
 
     authorization_policies:
       termix:

docs/reverse-proxy.md

@@ -0,0 +1,60 @@
+# Reverse Proxy
+
+Some reverse proxies may need some configuration changes to support Termix
+
+## NGINX
+
+In `nginx.conf` you need to "upgrade" the connection to support websockets using:
+
+```
+proxy_set_header Connection 'upgrade';
+```
+
+for example:
+
+```
+location / {
+    proxy_pass http://localhost:8080;
+
+    proxy_set_header Host $host;
+    proxy_set_header X-Real-IP $remote_addr;
+
+    proxy_http_version 1.1;
+    proxy_set_header Upgrade $http_upgrade;
+    proxy_set_header Connection "upgrade";
+}
+```
+
+## Traefik
+
+If you use Docker, in your `docker-compose.yml` add these labels, filled out as needed:
+
+```
+labels:
+  - "traefik.enable=true"
+
+  - "traefik.http.routers.termix.entrypoints=http"
+  - "traefik.http.routers.termix.rule=Host(`termix.local.domain.com`) || Host(`termix.domain.com`)"
+  - "traefik.http.middlewares.termix-https-redirect.redirectscheme.scheme=https"
+  - "traefik.http.routers.termix.middlewares=termix-https-redirect"
+
+  - "traefik.http.routers.termix-secure.entrypoints=https"
+  - "traefik.http.routers.termix-secure.rule=Host(`termix.local.domain.com`) || Host(`termix.domain.com`)"
+  - "traefik.http.routers.termix-secure.tls=true"
+  - "traefik.http.routers.termix-secure.tls.certresolver=cloudflare"
+  - "traefik.http.routers.termix-secure.service=termix"
+
+  - "traefik.http.services.termix.loadbalancer.server.port=8080"
+
+  - "traefik.docker.network=proxy"
+```
+
+## Caddy
+
+Caddy has native WebSocket support so no extra configs should be needed.
+
+```
+termix.domain.com {
+    reverse_proxy localhost:8080
+}
+```

sidebars.ts

@@ -13,10 +13,7 @@ const sidebars: SidebarsConfig = {
         {
           type: 'category',
           label: 'Server',
-          items: [
-            'install/server/docker',
-            'install/server/manual',
-          ],
+          items: ['install/server/docker', 'install/server/manual'],
         },
         {
           type: 'category',
@@ -31,6 +28,11 @@ const sidebars: SidebarsConfig = {
         },
       ],
     },
+    {
+      type: 'category',
+      label: 'Setup',
+      items: ['reverse-proxy']
+    },
     {
       type: 'category',
       label: 'Features',
@@ -42,29 +44,17 @@ const sidebars: SidebarsConfig = {
         {
           type: 'category',
           label: 'Authentication',
-          items: [
-            'oidc',
-            'totp',
-            'rbac',
-            'security',
-          ],
+          items: ['oidc', 'totp', 'rbac', 'security'],
         },
         {
           type: 'category',
           label: 'Networking',
-          items: [
-            'tunnels',
-            'server-stats',
-            'docker',
-            'ssl',
-          ],
+          items: ['tunnels', 'server-stats', 'docker', 'ssl'],
         },
         {
           type: 'category',
           label: 'Data',
-          items: [
-            'json-import',
-          ],
+          items: ['json-import'],
         },
       ],
     },

src/components/homepage/index.tsx

@@ -14,71 +14,71 @@ const FeatureList: FeatureItem[] = [
     title: 'SSH Terminal Access',
     description: (
       <>
-        Full-featured terminal with split-screen support (up to 4 panels) and tab system.
-        Customize with themes, fonts, and configurations.
+        Full-featured terminal with split-screen support (up to 4 panels) and tab system. Customize
+        with themes, fonts, and configurations.
       </>
     ),
   },
   {
     title: 'Remote File Manager',
     description: (
       <>
-        Manage files on remote servers with support for code, images, audio, and video.
-        Upload, download, rename, delete, and move files seamlessly.
+        Manage files on remote servers with support for code, images, audio, and video. Upload,
+        download, rename, delete, and move files seamlessly.
       </>
     ),
   },
   {
     title: 'Docker Management',
     description: (
       <>
-        Control containers with start, stop, pause, and remove. View stats and access
-        docker exec terminals for container management.
+        Control containers with start, stop, pause, and remove. View stats and access docker exec
+        terminals for container management.
       </>
     ),
   },
   {
     title: 'SSH Tunnel Management',
     description: (
       <>
-        Create and manage SSH tunnels with automatic reconnection and health monitoring
-        for secure access to remote services.
+        Create and manage SSH tunnels with automatic reconnection and health monitoring for secure
+        access to remote services.
       </>
     ),
   },
   {
     title: 'Host & Credentials Manager',
     description: (
       <>
-        Save and organize SSH connections with tags, folders, and reusable credentials.
-        Automate SSH key deployment across servers.
+        Save and organize SSH connections with tags, folders, and reusable credentials. Automate SSH
+        key deployment across servers.
       </>
     ),
   },
   {
     title: 'Server Monitoring',
     description: (
       <>
-        Monitor CPU, memory, disk usage, network activity, uptime, and system information
-        on connected servers.
+        Monitor CPU, memory, disk usage, network activity, uptime, and system information on
+        connected servers.
       </>
     ),
   },
   {
     title: 'Role-Based Access Control',
     description: (
       <>
-        Create roles and share hosts across users. Manage permissions with OIDC, 2FA support,
-        and a user session system.
+        Create roles and share hosts across users. Manage permissions with OIDC, 2FA support, and a
+        user session system.
       </>
     ),
   },
   {
     title: 'Multi-Platform Support',
     description: (
       <>
-        Available as a web app, desktop application (Windows, macOS, Linux), and mobile app
-        with a modern interface.
+        Available as a web app, desktop application (Windows, macOS, Linux), and mobile app with a
+        modern interface.
       </>
     ),
   },
@@ -87,7 +87,9 @@ const FeatureList: FeatureItem[] = [
 function Feature({ title, description }: FeatureItem) {
   return (
     <div className={styles.featureCard}>
-      <Heading as="h3" className={styles.featureTitle}>{title}</Heading>
+      <Heading as="h3" className={styles.featureTitle}>
+        {title}
+      </Heading>
       <p className={styles.featureDescription}>{description}</p>
     </div>
   );