hotel

Start apps from your browser and use local domains/https automatically

Tip: if you don't enable local domains, hotel can still be used as a catalog of local servers.

Hotel works great on any OS (macOS, Linux, Windows) and with all servers :heart: * Node (Express, Webpack) * PHP (Laravel, Symfony) * Ruby (Rails, Sinatra, Jekyll) * Python (Django) * Docker * Go * Apache, Nginx * ...

To all the amazing people who have answered the Hotel survey, thanks so much <3 !

v0.8.0 upgrade

.localhost

.dev

If you're upgrading, please be sure to: 1. Remove

"tld": "dev"

~/.hotel/conf.json

hotel stop && hotel start

Support

If you are benefiting from hotel, you can support its development on Patreon.

You can view the list of Supporters here https://thanks.typicode.com.

Video

• Starting apps with Hotel - Spacedojo Code Kata by Josh Owens

Features

• Local domains -

  http://project.localhost

• HTTPS via local self-signed SSL certificate -

  https://project.localhost

• Wildcard subdomains -

  http://*.project.localhost

• Works everywhere - macOS, Linux and Windows
• Works with any server - Node, Ruby, PHP, ...
• Proxy - Map local domains to remote servers
• System-friendly - No messing with

  port 80

  ,

  /etc/hosts

  ,

  sudo

  or additional software
• Fallback URL -

  http://localhost:2000/project

• Servers are only started when you access them
• Plays nice with other servers (Apache, Nginx, ...)
• Random or fixed ports

Install

npm install -g hotel && hotel start

Hotel requires Node to be installed, if you don't have it, you can simply install it using one of the following method:

• https://github.com/creationix/nvm

  nvm install stable

• https://brew.sh

  brew install node

You can also visit https://nodejs.org.

Quick start

Local domains (optional)

To use local

.localhost

See instructions here.

Add your servers

# Add your server to hotel
~/projects/one$ hotel add 'npm start'
# Or start your server in the terminal as usual and get a temporary local domain
~/projects/two$ hotel run 'npm start' 

Visit localhost:2000 or http(s)://hotel.localhost.

Alternatively you can directly go to

http://localhost:2000/one
http://localhost:2000/two

http(s)://one.localhost
http(s)://two.localhost 

Popular servers examples

Using other servers? Here are some examples to get you started :)

hotel add 'ember server'                               # Ember
hotel add 'jekyll serve --port $PORT'                  # Jekyll
hotel add 'rails server -p $PORT -b 127.0.0.1'         # Rails
hotel add 'python -m SimpleHTTPServer $PORT'           # static file server (Python)
hotel add 'php -S 127.0.0.1:$PORT'                     # PHP
hotel add 'docker-compose up'                          # docker-compose
hotel add 'python manage.py runserver 127.0.0.1:$PORT' # Django
# ...

On Windows use

"%PORT%"

'$PORT'

See a Docker example here..

Proxy requests to remote servers

Add your remote servers

~$ hotel add http://192.168.1.12:1337 --name aliased-address
~$ hotel add http://google.com --name aliased-domain 

You can now access them using

http://aliased-address.localhost # will proxy requests to http://192.168.1.12:1337
http://aliased-domain.localhost # will proxy requests to http://google.com

CLI usage and options

hotel add  [opts]
hotel run  [opts]

Examples
hotel add 'nodemon app.js' --out dev.log  # Set output file (default: none)
hotel add 'nodemon app.js' --name name    # Set custom name (default: current dir name)
hotel add 'nodemon app.js' --port 3000    # Set a fixed port (default: random port)
hotel add 'nodemon app.js' --env PATH     # Store PATH environment variable in server config
hotel add http://192.168.1.10 --name app  # map local domain to URL
hotel run 'nodemon app.js'                # Run server and get a temporary local domain
Other commands
hotel ls     # List servers
hotel rm     # Remove server
hotel start  # Start hotel daemon
hotel stop   # Stop hotel daemon

To get help

hotel --help
hotel --help 

Port

For

hotel

var port = process.env.PORT || 3000
server.listen(port)

hotel add 'cmd -p $PORT'  # OS X, Linux
hotel add "cmd -p %PORT%" # Windows

Fallback URL

If you're offline or can't configure your browser to use

.localhost

Configurations, logs and self-signed SSL certificate

You can find hotel related files in

~/.hotel

~/.hotel/conf.json
~/.hotel/daemon.log
~/.hotel/daemon.pid
~/.hotel/key.pem
~/.hotel/cert.pem
~/.hotel/servers/.json

By default,

hotel

{
  "port": 2000,
  "host": '127.0.0.1',

  // Timeout when proxying requests to local domains
  "timeout": 5000,
  // Change this if you want to use another tld than .localhost
  "tld": 'localhost', 
  // If you're behind a corporate proxy, replace this with your network proxy IP (example: "1.2.3.4:5000")
  "proxy": false
}

To override a value, simply add it to

~/.hotel/conf.json

hotel stop && hotel start

Third-party tools

• Hotelier Hotelier (Mac & Windows Tray App)
• Hotel Clerk OS X menubar
• HotelX Another OS X menubar (only 1.6MB)
• alfred-hotel Alfred 3 workflow
• Hotel Manager Gnome Shell extension

FAQ

Setting a fixed port

hotel add --port 3000 'server-cmd $PORT' 

Adding

X-Forwarded-*

headers to requests

hotel add --xfwd 'server-cmd'

Setting

HTTP_PROXY

env

Use

--http-proxy-env

~/.hotel/servers

hotel add --http-proxy-env 'server-cmd'

Proxying requests to a remote

https

server

hotel add --change-origin 'https://jsonplaceholder.typicode.com'

When proxying to a

https

.localhost

host

ENOSPC

and

EACCES

errors

If you're seeing one of these errors in

~/.hotel/daemon.log

hotel

sudo

~/.hotel

$USER

# to fix permissions
sudo chown -R $USER: $HOME/.hotel

See also, https://docs.npmjs.com/getting-started/fixing-npm-permissions

Configuring a network proxy IP

If you're behind a corporate proxy, replace

"proxy"

~/.hotel/conf.json

{
  "proxy": "1.2.3.4:5000"
}

License

MIT

Patreon - Supporters ✨