Documentation
Updated: 8th June 2024
Getting Started
System Requirements
PHP 8.1.2 or higher
MYSQL (PHP 8 Supported)
Compatible Browsers: Any
Supported OS: Linux, MacOS and Windows
Installation
After purchasing Swiftchats, you will get a zipped folder. After unzipping the folder, you will get two folders, the source code folder and the documentation folder.
documentation
source-code
Database Setup
- Create a new MySQL database.
- Create a new MySQL username and password.
- Assign full privileges to your database username.
Uploading Code
Before starting to upload the files, please make sure your file explorer has the option to view hidden files turned on. On some operating systems, the dotfiles are hidden by default.
- Upload the source-code folder to your server public_html or domain root directory where Swiftchats will be installed.
- Create a new MySQL database and DB user from your server and assign that user to the database
Changing the public directory
Configure your web server's document / web root to point to the public directory of the software. For example, if you've uploaded the software in example.com folder, your web directory should be changed to example.com/public folder.
Installer Setup
Once you have configured the steps above, go to your main url e.g. http://YOUR_URL which should redirect you to the installation page. Go through each installation step and grant folder permissions where necessary.
1. Server Requirements
The following server requirements must be met
- PHP Version(>=8.1.0)
- PDO
- mbstring
- fileinfo
- openssl
- tokenizer
- json
- curl
2. Granting permissions
The following permissions are required
- storage/framework
- storage/logs
- bootstrap/cache
- public/uploads
To grant permission 775 for the following folders storage/framework, storage/logs, and bootstrap/cache in cPanel, follow the steps below:
- Go to the root directory of your project, where you will find the folders storage and bootstrap.
- If you are using cPanel, Right-click on the storage folder and select "Change Permissions." if you are on your server terminal type
chmod 775 storage - In the "Change Permissions" dialog box, set the numeric value to "775" and make sure that the "Recurse into subdirectories" checkbox is checked.
- Click on the "Change Permissions" button to save the changes.
- Repeat steps 4-6 for the storage/logs and bootstrap/cache folders.
Note: The permission 775 means that the owner of the file or folder has full permissions (read, write, and execute), while the group and others have read and execute permissions only. It is a commonly used permission setting for directories in web hosting environments.
3. Database Setup
You have to fill the following information with the information obtained above (for your database)
- Database host - 127.0.0.1
- Database Port - 3306
- Database Name - (From the database configuration above)
- Database User Name - (From the database configuration above)
- Database Password - (From the database configuration above)
Trouble Shooting Your Installation
If you are facing issues with the installer, you can try the steps below
- Grant access to your .env file by running
chown -R www-data:www-data .envif you can access the terminal. - Go to storage folder and delete
installedfile - Retry installing the script again