BoxBilling
BoxBilling is an open source, and free billing and client management software which helps any kind of companies, startups or even individuals who wish to automate their billing process along with tools and features which will allow you starting your business today!
You can simplify your web hosting business by putting your billing cycle in control by integrating your favorite server management software to BoxBilling.
BoxBilling is self-hosted — all you need is a compatible web server, and a MySQL database. For further information, check the requirements section.
Table of content
Requirements
Although BoxBilling may work in lower or smaller conditions, we highly recommend you to ensure that your environment has the following software installed:
- PHP 7.2, or higher.
- MySQL 8, or higher.
Installation
Obtaining a copy from GitHub releases
Running from the source code
To clone and run BoxBilling, you'll first need to download an up-to-date ZIP archive and save it to your computer locally.
Then, extract the contents of the "src" folder inside the ZIP archive to your web server's public folder (usually, that's called "htdocs" or "public_html"). Your web directory's structure will now look like this:
- htdocs
- bb-data
- bb-library
- bb-module
- ...
We do not store the Composer packages in our GitHub repository, we use Composer for that. Composer is a dependency manager for PHP, just like the NPM of Node.js, or PIP of Python.
If you don't have Composer installed, or it's your first time with Composer, you probably may want to read Composer's getting started guide.
If you don't have SSH access to your server, or your webmaster in your shared hosting environment doesn't let you use Composer, you may not be able to install the required packages for BoxBilling. In that case, you probably should install BoxBilling by obtaining a ready-to-install copy from GitHub releases.
If you've already installed Composer, head over to the folder where you copied the content of the "src" folder to, and run the following command to download the required packages to your web server:
$ composer install
Now, as you have everything ready to start the installation of BoxBilling, head over to your web server, and follow on-screen instructions to complete the installation using web installer. Ta-da, you've done it! 🎉
Running with Docker
This guide assumes you already have Docker, Git and GNU make installed.
To clone the repository, first run these commands in your command line:
# Clone this repository
$ git clone https://github.com/boxbilling/boxbilling
# Navigate to the local repository
$ cd boxbilling
# Run the app with some help from Docker
$ make all
Now, you can navigate to your web server in your browser. If you're using a PC, or directly a server without a server manager like Plesk, this address will probably be localhost.
Contributing
Follow contributors' guidelines
Licensing
BoxBilling is licensed under the Apache License, Version 2.0. See LICENSE for full license text.
