Skip to content

docs: add self-hosted deployment guide with Nginx and Cloudflare Tunnel - #50

Open
tarunagnihotri534 wants to merge 1 commit into
AOSSIE-Org:mainfrom
tarunagnihotri534:docs/self-hosted-deployment
Open

tarunagnihotri534 wants to merge 1 commit into
AOSSIE-Org:mainfrom
tarunagnihotri534:docs/self-hosted-deployment

Conversation

@tarunagnihotri534

Copy link
Copy Markdown

Addressed Issues

Fixes #11

Description

Adds documentation to README.md explaining how to expose a self-hosted ThruBox-Server Docker container to the internet using Nginx reverse proxy or Cloudflare Tunnel.

  • Architecture & Local Hardening: Guidance to bind port 3000 to 127.0.0.1:3000:3000 to prevent direct unproxied exposure.
  • Nginx Reverse Proxy: Setup instructions with a reverse-proxy configuration, forwarded client IP headers, payload size configuration, HTTPS setup with Certbot, and troubleshooting.
  • Cloudflare Tunnel (cloudflared): Host CLI and Docker Compose approaches for exposing the service without opening inbound ports.
  • Post-Deployment Security: Guidance covering API key protection, rate limiting, and CORS configuration.
  • Cross-References: Added links from the existing Docker and CORS sections to the new self-hosting guide.

Screenshots/Recordings

1. Self-Hosting Overview & Docker Hardening -

Screenshot (3746)

2. Nginx Reverse Proxy & SSL-

Screenshot (3747)

3. Cloudflare Tunnel & Security Checklist-

Screenshot (3748) Screenshot (3749)

Additional Notes

The documentation and configuration examples were reviewed against the repository's existing Docker/server implementation and the relevant Nginx and Cloudflare setup requirements.

Checklist

  • My PR addresses a single issue
  • My code follows the project's code style and conventions
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings or errors
  • I have joined the Discord server and I will share a link to this PR with the project maintainers there
  • I have read the Contributing Guidelines

⚠️ AI Notice - Important!

AI assistance was used for drafting and reviewing the documentation and configuration examples. The final changes were reviewed against the repository's implementation.

@coderabbitai

coderabbitai Bot commented Sep 26, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Repository: AOSSIE-Org/ThruBox-Server/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: d5b3d42a-ac54-4d02-bc78-6118143a2ffc


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added enhancement New feature or request documentation Changes to documentation files size/L Large PR (201-500 lines changed) first-time-contributor First PR of an external contributor needs-review labels Sep 26, 2026
@github-actions

Copy link
Copy Markdown
Contributor
Messages
📖

⚠️ PR Template Check

These are non-blocking, but please fix:

  • PR description is missing required sections:
  • ### Addressed Issues:

Please follow the PR template.

Generated by 🚫 dangerJS against 46adf8f

@gitcordapp

gitcordapp Bot commented Sep 27, 2026

Copy link
Copy Markdown

Link your account with Gitcord

Thanks for opening this PR, @tarunagnihotri534!

To receive Discord notifications and contributor tracking for this organization:

  1. Join Discord: https://discord.gg/hjUhu33uAn
  2. In Discord, run /link tarunagnihotri534
  3. Paste the verification code into your GitHub bio (or a public gist)
  4. Click Verify in Discord (or run /verify-link tarunagnihotri534)

Once linked, Gitcord can notify you about reviews, merges, and more.

— Posted by Gitcord

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Changes to documentation files enhancement New feature or request first-time-contributor First PR of an external contributor needs-review size/L Large PR (201-500 lines changed)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE]: Add documentation for self-hosted deployment (Nginx and Cloudflare Tunnel)

1 participant