Quick Start

Install the Client

Download the appropriate client for your architecture.

Move the binary to a directory that's in your PATH, and ensure that it's executable.

mv ~/download/crproxy-linux-amd64 ~/bin/crproxy
chmod +x ~/bin/crproxy

Create an API Key

  • Sign in to the web interface and click the API Keys menu item.
  • Click the Create button.
  • Give your API Key any name you'd like.
  • Click the Create button.

The API Key is a secret token you will use to authenticate the crpoxy command-line client with proxy-servers.

Create a Configuration File

Create a configuration file in $HOME/.crproxy with your API Key and a proxy-server you'd like to use. You'll want to choose a local proxy-server for the best performance. Sign in to the web interface and click the Proxy-Servers menu item to view available locations.

api-key = _YOUR_API_KEY_
proxy-server = de1.crproxy.com

These values serve as defaults for the corresponding command line arguments.

Serve Files From Your Laptop

Run the crproxy command from the command line to share a local directory with a friend or colleague.

crproxy share ./shared-directory

Serve a Website From Your Laptop

Receive webhooks on your development machine to test an integration, or provide a colleague or client with a link to a site served from your laptop.

crproxy proxy http://localhost:1234/

Command-Line Help

View help using the -help flag.

crproxy share -help
crproxy proxy -help