Back to all templates
InvoiceShelf logo

InvoiceShelf

Application512MB+ RAM

Open source invoicing and accounting app for freelancers and small businesses

applicationinvoicinginvoiceshelfopen-sourceself-hosteddocker

Deploy InvoiceShelf in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select InvoiceShelf

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy InvoiceShelf on a VPS with Server Compass

Use the InvoiceShelf template in Server Compass to deploy a self-hosted invoicing and accounting app with MariaDB storage on your VPS, then verify the InvoiceShelf web UI in a browser.

About 7 minutesBrowser verified
1
Step 1

Open the server Apps tab

Select your VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating an InvoiceShelf app
2
Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template
3
Step 3

Search for InvoiceShelf

Use the template picker search to find InvoiceShelf in the Server Compass template catalog.

Searching for InvoiceShelf in the Server Compass template picker
4
Step 4

Select the InvoiceShelf template

Choose the InvoiceShelf template. Server Compass fills the InvoiceShelf web service, MariaDB service, Laravel app key, database name, database user, and database passwords.

InvoiceShelf template selected in Server Compass
5
Step 5

Review the InvoiceShelf settings

Confirm the app name and compose services. In this run, the app was named invoiceshelf-demo and used host port 4108.

Reviewing InvoiceShelf project settings and compose services
6
Step 6

Deploy InvoiceShelf

Review the generated environment values, confirm the port is available, and click Deploy Now.

Reviewing InvoiceShelf environment variables and port before deployment
7
Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the InvoiceShelf image, starts the container, and verifies the stack.

Server Compass deploying the InvoiceShelf template on the VPS
8
Step 8

Confirm InvoiceShelf is running

After deployment finishes, return to the Apps tab and confirm the InvoiceShelf app is marked Running with its application URL available.

InvoiceShelf template running in the Server Compass Apps tab
9
Step 9

Open InvoiceShelf in the browser

Open the application URL in a browser. The InvoiceShelf web UI confirms the site is reachable.

The deployed InvoiceShelf web UI loaded in a browser

After InvoiceShelf Opens

  • Sign in with the initial admin account and configure company details before production use.
  • Configure company settings, HTTPS, mail delivery, and invoice numbering before production use.
  • Add a domain and HTTPS before exposing InvoiceShelf to users.
  • Back up the InvoiceShelf MySQL volume before relying on it for production billing data.

Verified Result

The InvoiceShelf web UI loaded successfully in a browser.

InvoiceShelf deployment questions

What does the InvoiceShelf template deploy?

It deploys the InvoiceShelf web application with MariaDB database storage.

Which port did the tutorial use?

The tutorial used host port 4108, which maps to the InvoiceShelf web service on container port 8080.

Why does the guide stop at the login or setup web UI?

The tutorial verifies the clean InvoiceShelf web UI because company settings, email delivery, invoice numbering, and payment configuration depend on the production server.

Should this become a blog post?

No. The deployment guide should live on the InvoiceShelf template detail page and be linked from the reusable template deployment docs page.

After Deployment

After deploying InvoiceShelf with Server Compass, complete these steps to finish setup

1

Visit the application URL

2

Step through the install wizard — DB host is db

3

Create the admin user during setup

4

Configure company details, currencies, and tax settings

Need help? Check out our documentation for detailed guides.

InvoiceShelf FAQ

Common questions about self-hosting InvoiceShelf

How do I deploy InvoiceShelf with Server Compass?

Simply download Server Compass, connect to your VPS, and select InvoiceShelf 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 InvoiceShelf?

InvoiceShelf requires a minimum of 512MB 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 InvoiceShelf data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard InvoiceShelf backup and restore procedures.

How do I update InvoiceShelf to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest InvoiceShelf image will be pulled and deployed with zero downtime.

Is InvoiceShelf free to self-host?

InvoiceShelf 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.

Ready to Self-Host InvoiceShelf?

Download Server Compass and deploy InvoiceShelf to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass