Documentation (v2.5)

Introduction

Welcome to the official documentation for Project LOGGED! LOGGED provides a straightforward solution for implementing secure login and signup (authentication) systems on your MOFH (My Own Free Host) website. Designed for ease of installation and minimal maintenance.

Version 2.5 Updates

Version 2.5 brings several enhancements and corrections, as well as a significant overhaul to the multi-site system. However, it's important to note that with this update, some features from version 2.1 have been deprecated. These include the custom domain feature and the easier multi-site system introduced in v2.1. Instead, we're reverting to the multi-site system used in version 1.8 (with improvements of course).

Key Features

• Simple Setup-and-Forget Implementation: Easy to install and requires minimal maintenance.
• Secure Login and Signup Functionalities: Robust security measures in place.
• Compatibility with MOFH-Hosted Websites: Designed for seamless integration with MOFH hosting environments.
• Enhanced Multi-Site System: Improved multi-site functionality for managing authentication across multiple domains.
• Deprecated Features: Custom domain support and the easier multi-site system introduced in v2.1 have been deprecated.

Important Changes

Here are the key changes that may affect interactions with Project LOGGED:

• Stub Mode: With stub mode enabled, pages will only render if they are whitelisted. Because LOGGED itself doesn't rely on persistent data, this approach should work in most cases. If you have custom implementations, please create an Issue on GitHub for assistance.

Requirements

• PHP 8.0+ (PHP 8.2 recommended)
• Apache or NGINX with .htaccess parser (MOFH have this by default)

For NGINX, see the NGINX section below for additional instructions.

Installation

Follow these steps to install Project LOGGED:

1. Download the latest release.
2. If you have an existing index.php and .htaccess file in your root folder, remove them from the zip to avoid accidental file replacement.
3. Extract the files to the root folder of your domain (e.g., htdocs, www, var_html, etc.).
4. Note: LOGGED is designed to run in the root folder and will not interfere with your existing website. All LOGGED files are contained within the sys-auth directory.
5. If you removed the .htaccess file earlier, edit your existing .htaccess and add LOGGED's rules at the very beginning of the file.
6. Edit the configuration files located at /sys-auth/app-config. Refer to the explanation below for details.

Configuration

Configuration files are located under /sys-auth/config and are the only files needed to be edited for a normal installation. By default, you will find three configuration files: system.php, branding.php, and network.php. Please refer to the details below for explanations on what the values should be.

NOTE: LOGGED's configurations are cached for performance reasons. If you make changes and they're not reflected, enable development mode, refresh the page, make sure changes are reflected, and then turn off development mode. The first load will always return an error, just refresh the page.