InvoicePlane is a popular open-source invoicing solution that helps individuals and businesses create and manage invoices, quotes, and payments. In this tutorial, we will learn how to install InvoicePlane on MXLinux using the command-line interface (CLI) and Apache web server.
Before we proceed with the installation, please make sure you have the following requirements met on your system:
First, we need to download the latest version of InvoicePlane from its official GitHub repository using the following command:
git clone https://github.com/InvoicePlane/InvoicePlane.git invoiceplane
This command will download the InvoicePlane codebase and save it in the invoiceplane directory under your current working directory.
InvoicePlane has several dependencies that need to be installed before we can run its setup process. We will use the Composer package manager to install these dependencies.
To install Composer, simply run the following commands:
cd /tmp
curl -sS https://getcomposer.org/installer -o installer.php
sudo php installer.php --install-dir=/usr/local/bin --filename=composer
Once Composer is installed, navigate to the invoiceplane directory and run the following command to install the dependencies:
composer install
We need to create a database for InvoicePlane to store its data. You can use either MySQL or MariaDB server for this purpose.
To create a new database for InvoicePlane, run the following command:
sudo mysql -u root -p
This command will prompt you for the database user's password. Enter the password and hit Enter.
Once you're in the MySQL/MariaDB shell, you can create the database by running this SQL command:
CREATE DATABASE invoiceplane_db;
Replace invoiceplane_db with the desired name of your database.
Next, create a new user and assign the required permissions to the user for managing the invoiceplane_db database:
CREATE USER 'invoiceplane_user'@'localhost' IDENTIFIED BY 'your-password';
GRANT ALL PRIVILEGES ON invoiceplane_db.* TO 'invoiceplane_user'@'localhost' WITH GRANT OPTION;
FLUSH PRIVILEGES;
Replace invoiceplane_user with your desired username and your-password with your desired password.
Exit the MySQL/MariaDB shell by running the exit command.
Before we can use InvoicePlane, we need to configure it with the required settings.
First, navigate to the ipconfig.php file using the following command:
cd /path/to/invoiceplane
cp ipconfig.php.example ipconfig.php
nano ipconfig.php
Replace /path/to/invoiceplane with the actual path to your InvoicePlane installation directory.
In the ipconfig.php file, update the following values according to your server specifications:
$IP_VERSION = '1.6.0';
$IP_URL = 'http://localhost'; // update with your domain name or IP address
$IP_DBTYPE = 'mysqli';
$IP_DB = 'invoiceplane_db';
$IP_DBUSER = 'invoiceplane_user';
$IP_DBPASS = 'your-password';
Save and close the file.
Next, we need to set the proper permissions for the web server user to access read and write files.
Run the following commands to set the correct file permissions:
sudo chown -R www-data:www-data /path/to/invoiceplane
sudo chmod -R 755 /path/to/invoiceplane
sudo chmod -R 775 /path/to/invoiceplane/application/logs/
sudo chmod -R 775 /path/to/invoiceplane/application/config/
sudo chmod -R 775 /path/to/invoiceplane/uploads/
Replace /path/to/invoiceplane with the actual path to your InvoicePlane installation directory.
Finally, we need to create a virtual host to point to our InvoicePlane installation on the Apache web server.
Create a new virtual host configuration file using the following command:
sudo nano /etc/apache2/sites-available/invoiceplane.conf
Add the following configuration:
<VirtualHost *:80>
ServerName your-domain.com # replace with your own domain name
DocumentRoot /path/to/invoiceplane # replace with your own path
<Directory /path/to/invoiceplane>
Options Indexes FollowSymLinks MultiViews
AllowOverride All
Order allow,deny
allow from all
</Directory>
ErrorLog ${APACHE_LOG_DIR}/error.log
CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>
Replace your-domain.com with your domain name and /path/to/invoiceplane with the actual path to your InvoicePlane installation directory.
Save and close the file.
Next, enable the virtual host configuration and restart the Apache web server using the following commands:
sudo a2ensite invoiceplane.conf
sudo service apache2 restart
Now that we have completed the setup, we can run the installer to finalize the installation process.
To run the installer, simply navigate to the InvoicePlane installation directory using a web browser and follow the on-screen instructions.
You can access your InvoicePlane installation by going to your domain name or IP address in a web browser:
http://your-domain.com
Congratulations! You have successfully installed the InvoicePlane invoicing solution on MXLinux using the Apache web server. Now you can use it to create and manage invoices, quotes, and payments.
If you want to self-host in an easy, hands free way, need an external IP address, or simply want your data in your own hands, give IPv6.rs a try!
Alternatively, for the best virtual desktop, try Shells!
