mirror of https://github.com/gl-inet/glkvm-cloud.git synced 2026-09-17 16:15:25 +00:00

Files

T

GL.iNet-Yongping.Xie 2349554c22 doc: update docker-compose startup instructions

1. Updated the documentation for starting services with docker-compose,
   making the description clearer and more accurate.

Signed-off-by: GL.iNet-Yongping.Xie <yongping.xie@gl-inet.com>

2025-09-15 01:24:49 -07:00

1.3 KiB

Executable File

Raw Permalink Blame History

Quick Start

This guide shows how to deploy glkvm-cloud using the provided Docker Compose environment template.

Clone the repository and prepare the environment template

git clone https://github.com/gl-inet/glkvm-cloud.git
cd glkvm-cloud/docker-compose/
cp .env.example .env

Configure environment variables

Edit .env and update the required parameters:
- RTTYS_TOKEN: device connection token (leave empty to use the default)
- RTTYS_PASS: web management password (leave empty to use the default StrongP@ssw0rd)
- TURN_USER / TURN_PASS: coturn authentication credentials (leave empty to use the default)
- GLKVM_ACCESS_IP: glkvm cloud access address (leave empty to auto-detect at startup)
⚠️ Note: All configuration should be done in the .env file. You don’t need to modify docker-compose.yml, templates, or scripts directly.
Start the services
```
docker-compose up -d
```
If you modify .env or template files, make sure to apply the updates:
```
docker-compose down && docker-compose up -d
```
Platform Access

Once the installation is complete, access the platform via:
```
https://<your_server_public_ip>
```

1.3 KiB Executable File Raw Permalink Blame History Unescape Escape

Quick Start

1.3 KiB

Executable File

Raw Permalink Blame History