Quick Start
Get Penny up and running in minutes
1. Create a Configuration File
Create a penny.toml file:
["myapp.example.com"]
address = "127.0.0.1:3001"
wait_period = "10m"
health_check = "/"
command = "node server.js"This tells Penny:
- Route requests for
myapp.example.comto127.0.0.1:3001 - Start the app with
node server.js - Check
GET /to know when the app is ready - Kill the app after 10 minutes of inactivity
2. Start Penny
penny serveSince the config file is named penny.toml, you don't need to pass the path explicitly. You can also specify a custom path: penny serve /path/to/config.toml.
That's it. Requests to myapp.example.com will start node server.js, proxy traffic to 127.0.0.1:3001, and kill the process after 10 minutes of inactivity.
3. Validate Your Config
Before deploying, you can validate your configuration:
penny checkThis starts each app, runs its health check, and stops it to make sure everything works.