diff --git a/README.md b/README.md index e310f242..0fb8b98b 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,8 @@ The problem with windows is hard to set cronjob, better Linux ## Installation +### Git Clone + clone this repository or download zip or release 1. Rename **pages_template** to **pages** @@ -53,6 +55,41 @@ clone this repository or download zip or release 5. set [cronjob](https://github.com/hotspotbilling/phpnuxbill/wiki/Cron-Jobs) or scheduller for **system/cron.php** 6. make **config.php** unwriteable (chmod 644) +### Composer install + +Go to directory you want to install +Install Composer in your system + +```bash +# Debian/Ubuntu +sudo apt install composer +# Centos/Redhat +sudo yum install composer +``` + +install on curent directory + +```bash +composer create-project hotspotbilling/phpnuxbill . +``` + +install on new directory + +```bash +composer create-project hotspotbilling/phpnuxbill phpnuxbill +``` + +## Manual Installation + +1. Download project from [Master Branch](https://github.com/hotspotbilling/phpnuxbill/archive/refs/heads/master.zip) or from [Release](https://github.com/hotspotbilling/phpnuxbill/releases) +2. unzip and upload it to server +3. Rename **pages_template** to **pages** +4. Rename **config.sample.php** to **config.php** and make it writeable (chmod 777) +5. make writeable folder **ui/cache/** and **ui/compiled** +6. Open web and run installation +7. set [cronjob](https://github.com/hotspotbilling/phpnuxbill/wiki/Cron-Jobs) or scheduller for **system/cron.php** +8. make **config.php** unwriteable (chmod 644) + ## UPDGRADE for old version, below Version 6, backup **system/config.php**, delete all file except folder **pages**, upload all new files, put **config.php** in root folder (not in system folder), got to folder **/install** and run Update. diff --git a/composer.json b/composer.json new file mode 100644 index 00000000..6efbb598 --- /dev/null +++ b/composer.json @@ -0,0 +1,16 @@ +{ + "name": "hotspotbilling/phpnuxbill", + "type": "template", + "description": "PHPNuxBill a Hotspot Billing Software.", + "keywords": ["template"], + "homepage": "https://github.com/hotspotbilling/phpnuxbill", + "license": "MIT", + "authors": [ + { + "name": "ibnux", + "email": "me@ibnux.net", + "homepage": "https://ibnux.net", + "role": "Developer" + } + ] +}