phppayroll/phppayroll_installation.txt at main · php-crm/phppayroll · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
=======================================================================
                PHPPayroll — Open Source HR & Payroll Software
                INSTALLATION & SETUP GUIDE
=======================================================================

System Requirements:
--------------------
• PHP 7.4 or higher (PHP 8+ recommended)
• MySQL / MariaDB database
• Apache or Nginx Web Server
• Enabled PHP Extensions:
  - mysqli
  - pdo_mysql (optional for future updates)
  - openssl
  - mbstring
  - json
  - curl
• mod_rewrite enabled (optional for clean URLs)

Folder Structure (important paths):
-----------------------------------
/public               → Public root where index and modules are accessed
/app                  → MVC application files
/app/controllers      → Controller files
/app/models           → Data models
/app/views            → Views/templates
/app/config           → Application configuration + database connection
/database             → Contains installation SQL file

Installation File Location:
---------------------------
The SQL file required for database setup is located at:
    /database/phppayroll_install.sql

Installation Steps:
-------------------
1. Download the PHPPayroll source code and extract it to your web directory.
2. Create a new MySQL database (UTF8MB4 recommended).
3. Import the SQL file located at:
       /database/phppayroll_install.sql
4. Open file:
       /app/config/database.php
   and update the database credentials:
       DB_HOST, DB_NAME, DB_USER, DB_PASS
5. Open file:
       /app/config/config.php
   and update company / payroll system settings if required.

Accessing PHPPayroll (URL):
---------------------------
After successful installation, open your browser and enter:

    http://localhost/your-payroll-folder/public/

Example:
    http://localhost/phppayroll/public/

If uploading to online server:
    https://yourdomain.com/public/

Admin Login Credentials:
------------------------
Default credentials after installation:
• Email: admin@phppayroll.com
• Password: 123456

(If login fails, verify that the `password_hash` field in table
`phppayroll_users` is VARCHAR(255) and the value is not truncated.)

File & Folder Permissions:
--------------------------
• /public/uploads   → Writable for uploads (if enabled)
• /app/logs         → Writable for system logs (if enabled)

Security Notes:
---------------
• Delete /database/phppayroll_install.sql after installation.
• Change admin password immediately after first login.
• Keep database configuration private and secure.
• Do not expose /app/config folder via the web.

Recommended PHP Settings:
-------------------------
• max_execution_time = 300
• memory_limit = 512M
• upload_max_filesize = 32M
• post_max_size = 32M

Support & Community:
--------------------
Website: https://www.phppayroll.com
Live Demo: https://www.phppayroll.com/demo/
Download: https://www.phppayroll.com/download/
Documentation: https://www.phppayroll.com/documentation/
Features: https://www.phppayroll.com/features/
Contact: https://www.phppayroll.com/contact/

License:
--------
PHPPayroll is licensed under the MIT Open Source License.
You may use, modify, rebrand, and deploy commercially
while preserving this copyright notice.

=======================================================================
            Thank you for choosing PHPPayroll Open Source!
=======================================================================