1
Step 1Open the server Apps tab
Select the tutorial-vps VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.
Back to all templates
OpenResty
Development256MB+ RAM
OpenResty — high-performance Nginx with built-in LuaJIT, used as a base for API gateways, edge proxies, and custom Nginx setups
developmentdevtoolsopenrestyopen-sourceself-hosteddocker
Deploy OpenResty in 3 Steps
1
Connect Your VPS
Add your server credentials to Server Compass
2
Select OpenResty
Choose from our template library
3
Deploy & Configure
Fill in settings and click Deploy
No Docker knowledge required
Step-by-step deployment guide
Deploy OpenResty on a VPS with Server Compass
Use the OpenResty template in Server Compass to deploy the high-performance Nginx/LuaJIT web server on your VPS, then verify the default welcome page in a browser.
About 10 minutesBrowser verified
2
Step 2Choose an app template
Click New App and choose the template deployment path so Server Compass can load the built-in catalog.
3
Step 3Search for OpenResty
Use the template picker search to find OpenResty in the Server Compass template catalog.
4
Step 4Select the OpenResty template
Choose the OpenResty template. Server Compass fills the web server service, host port mapping, and persistent config/static HTML volumes.
5
Step 5Review the OpenResty settings
Confirm the app name and web UI port. In this run, the app was named openresty-manager-demo and used host port 4187.
6
Step 6Deploy OpenResty
Review the generated compose settings, confirm the OpenResty web port is available, and click Deploy.
7
Step 7Watch the deployment progress
Keep the deployment modal open while Server Compass uploads the compose file, pulls the OpenResty image, starts the container, and verifies the stack.
8
Step 8Confirm OpenResty is running
After deployment finishes, return to the Apps tab and confirm the OpenResty app is marked Running with its application URL available.
9
Step 9Open OpenResty in the browser
Open the application URL in a browser. The default OpenResty welcome page confirms the web server is reachable.
After OpenResty Opens
- Replace the default HTML in the `openresty_html` volume with your own static site or landing page.
- Add server blocks under the `openresty_config` volume for proxying or Lua-powered routes.
- Reload OpenResty after config changes and test the generated Nginx syntax.
- Use a derived image if you need extra Lua modules or a management UI.
Verified Result
The OpenResty web interface loaded successfully from the deployed container.
OpenResty deployment questions
What does the OpenResty template deploy?
It deploys the upstream OpenResty web server image with persistent volumes for Nginx config snippets and static HTML.
Which port did the tutorial use?
The tutorial used host port 4187, which maps to OpenResty container port 80.
Does OpenResty need setup after deployment?
The default page works immediately. For production, add your own config files and static content, then reload OpenResty.
Should this become a blog post?
No. The deployment guide should live on the OpenResty template detail page and be linked from the reusable template deployment docs page.
After Deployment
After deploying OpenResty with Server Compass, complete these steps to finish setup
1
Visit http://YOUR_SERVER_IP:{{PORT}} and confirm the default OpenResty welcome page renders
2
Add custom server blocks to the openresty_config volume: `docker compose cp my.conf openresty:/etc/nginx/conf.d/my.conf`
3
Reload Nginx without downtime: `docker compose exec openresty openresty -s reload`
4
(Optional) Build a derived image with your Lua modules / management UI baked in, and switch the `image:` line to your custom tag
Need help? Check out our documentation for detailed guides.
OpenResty FAQ
Common questions about self-hosting OpenResty
How do I deploy OpenResty with Server Compass?
Simply download Server Compass, connect to your VPS, and select OpenResty from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.
What are the system requirements for OpenResty?
OpenResty requires a minimum of 256MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.
Can I migrate my existing OpenResty data?
Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard OpenResty backup and restore procedures.
How do I update OpenResty to the latest version?
Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest OpenResty image will be pulled and deployed with zero downtime.
Is OpenResty free to self-host?
OpenResty is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.
Related Templates
View all Development
PocketBase
Open-source backend in a single file with realtime database, auth, and file storage
Appwrite
Open-source backend-as-a-service - self-hosted Firebase alternative
Parse Server
Open-source backend framework with dashboard
Supabase
Full Supabase self-hosted with Kong, GoTrue Auth, Realtime, and Studio
Ready to Self-Host OpenResty?
Download Server Compass and deploy OpenResty to your VPS in under 3 minutes. No Docker expertise required.
Download Server Compass