Invoice Ninja Application Documentation¶

This documentation provides comprehensive information about the containerized Invoice Ninja application deployment maintained by webgrip.

Purpose Statement¶

This documentation enables any engineer to understand what we built, why we built it this way, how to operate it safely, and how to evolve it—without leaving the repository.

Table of Contents¶

• Project Overview - What this project is and which upstream applications it packages
• Upstream Application - Facts about Invoice Ninja derived from official sources
• Configuration - Environment variables, volumes, and service settings
• Deployment - How to deploy and manage the application
• Operations - Day-to-day operational procedures
• Troubleshooting - Common issues and solutions
• Development - Development workflow and customization

Quick Start¶

1. Clone this repository
2. Copy .env.example to .env and configure database credentials
3. Run make start to start the application stack
4. Access Invoice Ninja at http://localhost:8080

For detailed instructions, see the Deployment Guide.

Image Policy¶

This repository builds and maintains organization-owned container images based on official upstream sources. Our Docker Compose configuration uses only our custom-built images to ensure consistency and security.