Skip to content

Commit aa5cc3f

Browse files
authored
Merge pull request #3 from B-AJ-Amar/dev
Dev
2 parents f04d8f5 + cac543b commit aa5cc3f

File tree

10 files changed

+478
-1513
lines changed

10 files changed

+478
-1513
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# GTunnel
1+
# gTunnel
22

3-
**GTunnel** is a fast, lightweight tunneling solution written in Go that allows you to expose local services to the internet through a secure tunnel. Similar to [ngrok](https://ngrok.com/) or [VSCode Port-Forwarding](https://code.visualstudio.com/docs/debugtest/port-forwarding), GTunnel provides a simple way to share your local development server with the world.
3+
**gTunnel** is a fast, lightweight tunneling solution written in Go that allows you to expose local services to the internet through a secure tunnel. Similar to [ngrok](https://ngrok.com/) or [VSCode Port-Forwarding](https://code.visualstudio.com/docs/debugtest/port-forwarding), GTunnel provides a simple way to share your local development server with the world.
44

55
![License](https://img.shields.io/github/license/B-AJ-Amar/gTunnel)
66
![Go Version](https://img.shields.io/github/go-mod/go-version/B-AJ-Amar/gTunnel)
@@ -634,7 +634,7 @@ We welcome contributions! Here's how you can help:
634634
635635
## 📄 License
636636
637-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
637+
This project is licensed under the Apache-2.0 license - see the [LICENSE](LICENSE) file for details.
638638
639639
## 🙏 Acknowledgments
640640

docs/blog/authors.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
amar:
2-
name: Amar A.J BOUAKAZ
2+
name: B A.J Amar
33
title: gTunnel Creator & Software Engineer & AI Student
44
url: https://github.com/B-AJ-Amar
55
image_url: https://github.com/B-AJ-Amar.png

docs/docs/deployment.md

Lines changed: 67 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,81 @@ sidebar_position: 8
44

55
# Deployment Guide
66

7-
This guide covers deploying gTunnel in various environments.
7+
Deploy your own gTunnel server to share and manage your tunnels. Choose from cloud platforms for quick setup or self-hosted solutions for more control.
88

9-
## Quick Deployment
9+
## 🚀 Quick Deployment with Render
1010

11-
### Using Docker
11+
The easiest way to deploy a gTunnel server is using Render's one-click deployment:
12+
13+
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/B-AJ-Amar/gTunnel)
14+
15+
**What you get with Render:**
16+
17+
-**Free HTTPS URL** (e.g., `https://your-app.onrender.com`)
18+
-**Automatic SSL certificates** - Secure by default
19+
-**Health checks and auto-restart** - High availability
20+
-**Auto-deploy on git push** - Continuous deployment
21+
-**Environment variable management** - Easy configuration
22+
-**Zero setup required** - Just click and deploy!
23+
24+
:::tip Easy Setup
25+
Render deployment includes all necessary configuration out of the box. Your server will be ready to use immediately after deployment.
26+
:::
27+
28+
29+
30+
31+
## VPS/Dedicated Server
32+
33+
**Using systemd (Linux):**
1234

1335
```bash
14-
# Run server
15-
docker run -p 8080:8080 gtunnel/server
36+
# Download and install
37+
wget https://github.com/B-AJ-Amar/gTunnel/releases/latest/download/gtunnel-server_linux_amd64.tar.gz
38+
tar -xzf gtunnel-server_linux_amd64.tar.gz
39+
sudo mv gts /usr/local/bin/
1640

17-
# Run client
18-
docker run gtunnel/client --server ws://localhost:8080
19-
```
41+
# Create service user
42+
sudo useradd --system --shell /bin/false gtunnel
43+
44+
# Create config
45+
sudo mkdir -p /etc/gtunnel
46+
echo "GTUNNEL_ACCESS_TOKEN=your-secret-token" | sudo tee /etc/gtunnel/server.env
47+
48+
# Create systemd service
49+
sudo tee /etc/systemd/system/gtunnel.service > /dev/null << EOF
50+
[Unit]
51+
Description=gTunnel Server
52+
After=network.target
53+
54+
[Service]
55+
Type=simple
56+
User=gtunnel
57+
ExecStart=/usr/local/bin/gts start --bind-address 0.0.0.0:7205
58+
EnvironmentFile=/etc/gtunnel/server.env
59+
Restart=always
60+
RestartSec=5
2061
21-
### Using Docker Compose
22-
23-
```yaml
24-
version: '3.8'
25-
services:
26-
gtunnel-server:
27-
image: gtunnel/server
28-
ports:
29-
- "8080:8080"
30-
environment:
31-
- AUTH_TOKEN=your-secret-token
62+
[Install]
63+
WantedBy=multi-user.target
64+
EOF
65+
66+
# Start and enable service
67+
sudo systemctl daemon-reload
68+
sudo systemctl enable gtunnel
69+
sudo systemctl start gtunnel
3270
```
3371

34-
## Production Deployment
72+
#### Other Options
73+
74+
For additional deployment methods, see our **[Installation Guide](./getting-started/installation.md)**:
75+
76+
3577

36-
More detailed production deployment instructions coming soon.
78+
## 🆘 Need Help?
3779

38-
## Cloud Providers
80+
If you encounter issues during deployment:
3981

40-
Instructions for deploying on AWS, GCP, Azure, and other cloud providers.
82+
1. Check our **[FAQ](./faq.md)** for common solutions
83+
2. Review the **[CLI Reference](./cli-reference.md)** for command details
84+
3. Visit our **[GitHub Issues](https://github.com/B-AJ-Amar/gTunnel/issues)** for support

0 commit comments

Comments
 (0)