hotel

A simple process manager for developers. Start apps from your browser and a...

CLI
typicode/hotelhotel

README

hotel Mac/Linux Build Status Windows Build status undefined


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


undefined

_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 replaces .dev local domain and is the new default. See https://ma.ttias.be/chrome-force-dev-domains-https-via-preloaded-hsts/ for context.

If you're upgrading, please be sure to:
1. Remove "tld": "dev" from your ~/.hotel/conf.json file
2. Run hotel stop && hotel start
3. Refresh your network settings

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


  1. ```sh
  2. npm install -g hotel && hotel start
  3. ```

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 domains, you need to configure your network or browser to use hotel's proxy auto-config file or you can skip this step for the moment and go directly to http://localhost:2000

__See instructions here__.

Add your servers


  1. ```sh
  2. # Add your server to hotel
  3. ~/projects/one$ hotel add 'npm start'
  4. # Or start your server in the terminal as usual and get a temporary local domain
  5. ~/projects/two$ hotel run 'npm start'
  6. ```

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

Alternatively you can directly go to

  1. ```
  2. http://localhost:2000/one
  3. http://localhost:2000/two
  4. ```

  1. ```
  2. http(s)://one.localhost
  3. http(s)://two.localhost
  4. ```

Popular servers examples


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

  1. ```sh
  2. hotel add 'ember server'                               # Ember
  3. hotel add 'jekyll serve --port $PORT'                  # Jekyll
  4. hotel add 'rails server -p $PORT -b 127.0.0.1'         # Rails
  5. hotel add 'python -m SimpleHTTPServer $PORT'           # static file server (Python)
  6. hotel add 'php -S 127.0.0.1:$PORT'                     # PHP
  7. hotel add 'docker-compose up'                          # docker-compose
  8. hotel add 'python manage.py runserver 127.0.0.1:$PORT' # Django
  9. # ...
  10. ```

On __Windows__ use "%PORT%" instead of '$PORT'

__See a Docker example here.__.

Proxy requests to remote servers


Add your remote servers

  1. ```sh
  2. ~$ hotel add http://192.168.1.12:1337 --name aliased-address
  3. ~$ hotel add http://google.com --name aliased-domain
  4. ```

You can now access them using

  1. ```sh
  2. http://aliased-address.localhost # will proxy requests to http://192.168.1.12:1337
  3. http://aliased-domain.localhost # will proxy requests to http://google.com
  4. ```

CLI usage and options


  1. ```sh
  2. hotel add <cmd|url> [opts]
  3. hotel run <cmd> [opts]

  5. # Examples

  7. hotel add 'nodemon app.js' --out dev.log  # Set output file (default: none)
  8. hotel add 'nodemon app.js' --name name    # Set custom name (default: current dir name)
  9. hotel add 'nodemon app.js' --port 3000    # Set a fixed port (default: random port)
  10. hotel add 'nodemon app.js' --env PATH     # Store PATH environment variable in server config
  11. hotel add http://192.168.1.10 --name app  # map local domain to URL

  13. hotel run 'nodemon app.js'                # Run server and get a temporary local domain

  15. # Other commands

  17. hotel ls     # List servers
  18. hotel rm     # Remove server
  19. hotel start  # Start hotel daemon
  20. hotel stop   # Stop hotel daemon
  21. ```

To get help

  1. ```sh
  2. hotel --help
  3. hotel --help <cmd>
  4. ```

Port


For hotel to work, your servers need to listen on the PORT environment variable.
Here are some examples showing how you can do it from your code or the command-line:

  1. ``` js
  2. var port = process.env.PORT || 3000
  3. server.listen(port)
  4. ```

  1. ```sh
  2. hotel add 'cmd -p $PORT'  # OS X, Linux
  3. hotel add "cmd -p %PORT%" # Windows
  4. ```

Fallback URL


If you're offline or can't configure your browser to use .localhost domains, you can __always__ access your local servers by going to localhost:2000.

Configurations, logs and self-signed SSL certificate


You can find hotel related files in ~/.hotel :

  1. ```sh
  2. ~/.hotel/conf.json
  3. ~/.hotel/daemon.log
  4. ~/.hotel/daemon.pid
  5. ~/.hotel/key.pem
  6. ~/.hotel/cert.pem
  7. ~/.hotel/servers/<app-name>.json
  8. ```

By default, hotel uses the following configuration values:

  1. ``` js
  2. {
  3.   "port": 2000,
  4.   "host": '127.0.0.1',
  5.   
  6.   // Timeout when proxying requests to local domains
  7.   "timeout": 5000,
  8.   
  9.   // Change this if you want to use another tld than .localhost
  10.   "tld": 'localhost',
  11.   
  12.   // If you're behind a corporate proxy, replace this with your network proxy IP (example: "1.2.3.4:5000")
  13.   "proxy": false
  14. }
  15. ```

To override a value, simply add it to ~/.hotel/conf.json and run 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


  1. ```sh
  2. hotel add --port 3000 'server-cmd $PORT'
  3. ```

Adding X-Forwarded-* headers to requests


  1. ```sh
  2. hotel add --xfwd 'server-cmd'
  3. ```

Setting HTTP_PROXY env


Use --http-proxy-env flag when adding your server or edit your server configuration in ~/.hotel/servers

  1. ```sh
  2. hotel add --http-proxy-env 'server-cmd'
  3. ```

Proxying requests to a remote https server


  1. ```sh
  2. hotel add --change-origin 'https://jsonplaceholder.typicode.com'
  3. ```

_When proxying to a https server, you may get an error because your .localhost domain doesn't match the host defined in the server certificate. With this flag, host header is changed to match the target URL._

ENOSPC and EACCES errors


If you're seeing one of these errors in `/.hotel/daemon.log, this usually means that there's some permissions issues. hotel daemon should be started without sudo and /.hotel should belong to $USER`.

  1. ```sh
  2. # to fix permissions
  3. sudo chown -R $USER: $HOME/.hotel
  4. ```

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" with your network proxy IP in ~/.hotel/conf.json. For example:

  1. ``` json
  2. {
  3.   "proxy": "1.2.3.4:5000"
  4. }
  5. ```

License


MIT

Patreon - Supporters ✨