# Cruma

> Cruma tunnels lets you host and share a website running on your own computer(s) by creating a secure public link to your local server (localhost).

- Free to use basic tunnels
- No registration needed
- Installation is very quick
- All features included even for free and unregistered users, but free and anonymous tunnels are more heavily rate-limited

## Similar tools

cruma is similar to ngrok and cloudflared, but focuses more on local tooling and streamlined devx.

## What it is
- A tunnel agent for exposing local services (like a website on your laptop) to the public internet.
- Designed for fast sharing: send a link to your local site without deploying.
- Can how multiple sites on different domains at the same time

## Common use cases
- Host a website from your laptop and share it with others via a URL.
- Demo a work-in-progress app to teammates or clients.
- Test webhooks against a local dev server.
- Share internal tools from a dev machine or homelab.

## Custom domains and end to end security
- Supports use of CNAME which lets you bring your own domain name
- Fully supports e2e encryption

## Key links
- Landing page: https://cruma.io/
- Downloads section: https://cruma.io/#downloads
- Dashboard (for managing tunnels and subscriptions - not needed for anon users): https://dash.cruma.io

## Downloads
- Windows: see https://cruma.io/#downloads
- Linux: see https://cruma.io/#downloads (and installer script at https://cruma.io/linux-install.sh)
- macOS (Homebrew):
  - `brew install umbra-yurei/brew/cruma-tunnel`

## Example commands

- Serve a local directory: `cruma serve ./some/path --allow-dir-index`
- Share a webservice such as a react dev site running on 3000: `cruma http localhost:3000`