Skip to content

INSTALLATION.md

Latest commit

 

History

History
137 lines (101 loc) · 3.74 KB

INSTALLATION.md

File metadata and controls

137 lines (101 loc) · 3.74 KB

Installation Guide

Follow the instructions below to install InvoicePlane on your preferred platform.

Table of Contents

  1. Prerequisites
  2. Installation Methods
  3. Platform-Specific Instructions
  4. Docker Installation
  5. Post-Installation
  6. Troubleshooting

Prerequisites

  • Web Server: Apache or Nginx
  • PHP: Version 8.1 or higher
  • Database: MariaDB

Installation Methods

1. Using the .zip File

  1. Download:

  2. Extract:

    • Unzip the package and upload the contents to your Nginx web server.

  3. Configuration:

    • Rename ipconfig.php.example to ipconfig.php.
    • Edit ipconfig.php and set your base URL.

  4. Setup:

    • Navigate to http://your-domain.com/index.php/setup in your browser and follow the on-screen instructions.

2. Cloning the Repository

  1. Clone:

    git clone https://github.com/InvoicePlane/InvoicePlane.git
cd InvoicePlane

  2. Dependencies:

    • Install PHP dependencies: 
      composer install
    • Install Node.js dependencies: 
      yarn install

  3. Build Assets:

    yarn build

  4. Configuration:

    • Rename ipconfig.php.example to ipconfig.php.
    • Edit ipconfig.php and set your base URL.

  5. Setup:

    • Navigate to http://your-domain.com/index.php/setup in your browser and follow the on-screen instructions.

Platform-Specific Instructions

Windows

  • Using XAMPP or similar is not recommended. Follow the standard installation steps. Clone Repository (if you want to contribute) or use the .zip file (if you want to quickly use InvoicePlane)

macOS

  • Using Laravel Herd:
    • Install Laravel Herd.
    • Place InvoicePlane files in the Herd sites directory.
    • Follow the standard installation steps.

Linux

  • Nginx + MariaDB + PHP Setup: If you have a local LAMPP (or LEMPP) stack, basically follow the steps from the Dockerfile files in the Docker setup
  • Configure Nginx to serve InvoicePlane.
  • cp ipconfig.php.example ipconfig.php
  • edit ipconfig.php to reflect location of the MariaDB database and the url to InvoicePlane
  • composer install
  • Install yarn
  • yarn build

Docker Installation

  1. Clone Docker Repository:

    git clone https://github.com/InvoicePlane/InvoicePlane-Docker.git
cd InvoicePlane-Docker

  2. Build and Run:

    docker-compose up --build -d

  3. Setup:

  • Access http://your-domain.com/index.php/setup to complete the installation.

Post-Installation

  • Access http://your-domain.com/index.php/setup to complete the installation.
  • It will guide you through the install wizard.
  • Log in with the credentials you provided in the wizard
  • In the settings you can set up InvoicePlane to your liking
  • Add Invoice Groups, Product Families, Product Units, etcetera
  • Start using InvoicePlane

Troubleshooting

If you encounter issues during installation or setup, follow these steps:

  1. Visit the Community Forums - Engage with other users and developers for help.
  2. Join our Discord Server - Get real-time assistance from the community.
  3. Check the InvoicePlane Wiki - Look for documented solutions to common problems.