What you get
- A terminal in any browser, on your laptop or your phone.
- No open ports. Your server connects out to Cloudflare. It works behind NAT and CGNAT.
- Sign in with your Cloudflare account. Only the people you list get in.
- Sessions keep running when you close the tab. It's real tmux, so
tmux attach works on the server too.
- Files beside the terminal. A panel like VS Code's: browse, download, rename, move and delete.
- Upload by drop or paste. Drop files on the terminal, or paste a screenshot. Its path is typed for you.
- Works on phones. Swipe to scroll. A key bar adds Esc, Tab, Ctrl and arrows.
- One command to set up.
./install.sh does the Cloudflare side and installs the services.
How it works
Your browser opens https://term.example.com. Cloudflare shows its login page first and lets only listed people through.
The request then travels through a tunnel to your server, where a small Node.js app attaches you to a tmux session.
Install
You need a domain on Cloudflare, Zero Trust turned on, and a Linux server
with systemd, tmux and Node.js 18 or newer. All on free plans.
Details: Before you start.
git clone https://github.com/syan-dev/cloudflare-tmux.git
cd cloudflare-tmux
./install.sh
The installer asks three questions: your hostname, who may log in as [email protected]:youruser, and a
Cloudflare API token used only during setup
(how to create it).
Then open https://term.example.com and sign in with your Cloudflare account.
Step by step, with every dashboard click written out:
Install.
Day to day
cloudflare-tmux status # is it online?
cloudflare-tmux add [email protected] carol # let someone log in (invite them as a member first)
cloudflare-tmux people # who may log in, and when they last did
cloudflare-tmux doctor # something wrong? it tells you the fix
Documentation
Full docs: https://syan-dev.github.io/cloudflare-tmux/
Reference: maintenance,
settings,
security model,
two-step code,
what gets created on Cloudflare,
multi-user install.
Development
npm install
AUTH_DISABLED=1 node server.js # http://127.0.0.1:7681, no Cloudflare needed
npm test
See CONTRIBUTING.md. Security issues: SECURITY.md.
License
MIT. Not affiliated with or endorsed by Cloudflare, Inc.
