, (*1)
PHP-Login
Version 3.1, (*2)
PHP-Login
is a simple login and signup system built with PHP, MySQL (with PDO), jQuery and Bootstrap 3. It is meant to be a starting point for PHP developers to build sites from and includes basic user management classes and methods., (*3)
Technologies used:
Prerequisites
-
PHP
required, (*4)
- Minimum version:
7.0
-
pdo_mysql
extension required
- Recommended to enable
shell_exec
-
MySQL
required, (*5)
-
Composer
required, (*6)
- Version
1.2.1+
recommended
-
mbstring
and dom
php extensions required, (*7)
If Composer is not installed on the system or accessible through shell_exec
, a self-contained composer.phar
file located in the install
directory is used, (*8)
-
cURL
recommended, (*9)
Components loaded via Composer
-
jQuery
- Version
3.1
- Pulled in via composer
-
Bootstrap
-
PHP-Mailer
-
JSON Web Tokens
(JWT) (Firebase implementation)
Other libraries
-
DataTables
Cropper
LoadingOverlay
-
Multiselect
General Recommendations
-
Enable SSL on your site! Get a free cert at LetsEncrypt, (*10)
- Their free tool Certbot makes this process virtually painless
-
Linux server running Apache or Nginx is preferred, (*11)
-
Shell access is recommended. While it is likely possible to install this library without shell access (such as on a shared web hosting provider), this is unsupported. It's highly recommended that you instead opt for a VPS provider such as DigitalOcean that allows you root shell access, (*12)
-
Run mysql_secure_installation
on server prior to app installation, (*13)
-
Host your database on an encrypted filesystem, (*14)
-
File/directory permissions should be locked down to an appropriate level, (*15)
Installation
Clone the Repository
$ git clone https://github.com/therecluse26/PHP-Login.git
Install necessary dependencies with Composer
$ composer install --no-dev
Run through web-based installer
Open this link in your web browser (replacing [yoursite.com] with your site address), (*16)
http://{yoursite.com}/install/index.php
Select an installation option from the pop-up modal that appears: Automated
or Manual
, (*17)
NOTE ** If you are upgrading from a prior version of PHP-Login (>3.1), you should install this version as new and then navigate to the /install/legacymigration/index.php
page to migrate your existing data to the new application version (to reflect schema updates) **, (*18)
Automated Installation Instructions, (*19)
Manual Installation Instructions, (*20)
Documentation
Site Config Settings, (*21)
API Methods, (*22)
* Full API documentation can be found by nagivating to: {yoursite.com}/docs/api/index.html
, (*23)
Change Log, (*24)