README

eZ Publish Basic is an open-source project to modernize the classic eZ Publish 2.x CMS, bringing its functionality up-to-date with PHP 8 standards while retaining its simplicity and community-focused design.

This project is led by 7x and aims to ensure the long-term viability of eZ Publish 2.x for community portal solutions and their future portability (export to another cms).

Documentation for this project will in the future be covering importing eZ Publish 2.x Database Content, Exporting eZ Publish 2.x Database content for import (As required to start, like say eZ Article or eZ FileManager or eZ ImageCatalog) from eZ Publish 2 into eZ Publish 6 (Latest stable version of eZ Publish 3 Kernel APIs) Open Source Code and Flexible Content Management where importing data is common and accepted part of any website project using a CMS.

LICENSE: GNU GPLv2 (or later)
Source Code https://github.com/se7enxweb/ezpublishbasic
Maintainer: 7x
Document Last revised: 2024.11.16

About

We are actively working to bring eZ Publish Basic 2.4.0 to the general public.

eZ Publish 2.4 is the completed work started by 7x years ago to upgrade eZ Publish 2 Kernel Implementation of a easy to use PHP Personal Home Page CMS or Community Website Building Platform to more modern PHP versions.

The story

Previously this was developed and released as eZ Community 2.3 the community portal distribution which provided partial incomplete PHP5 Port of the eZ Publish 2 Official Repository (Containing addition code never released to the public).

Today is a new day and a new chance to complete the work started by 7x with the eZ Community Distribution of eZ Pubilsh 2+.

To distinguish between different product releases we have decided to release the finished work under the original name with a brand identifier 'basic' to indicate that eZ publish basic or eZ Publish Basic is supporting PHP8.3 Web Servers and can be used today in 2024 to learn how to more quickly build simple web applications in minutes rather than days as common needs can follow existing developed code patterns in implementation phase(s). Learn by example, Learn by doing, build a bridge to a new world not a wall.

We are also incrementing the version number from 2.3.x to 2.4.x.x to give more version number space while clearly marking this release as unique. Short standard for the version numbers will be 2.4

Goals:

Provide an educational project for new developers to learn eZ Publish development concepts.
Deliver a simple starter solution for building a PHP-based CMS.
Enable a lightweight alternative for personal home page-based CMS needs.

The work

This project involves documenting and updating the following:

All 34+ admin module views.
All 34+ user module views used or exposed by default.
All (unknown number of) user module views not used or exposed by default.
All (unknown number of) module views as authenticated or not.
All (unknown number of) module views uniue POST/GET Actions Provided Per Module View(s).
Refactoring and extending existing PHP4/5 code to full PHP 8 compatibility.

Status Summary:

EL5: eZ User Websites Boot (Expected pages load correctly site wide without errors)
Extended: eZ Administration Website Boots (loads the UI without fatal or distracting errors) yet the eZ Admin Website requires additional refactoring for each admin module to work correctly in real life usage.
Real story: eZ Admin and eZ User Website Currently Require Extensive Development to free eZ Publish Basic from existing implementation limitations resulting in conflicts with the language preventing error free usage on a per siteacccess, module view, module view action(s) per module view.

Default eZPB User Modules Views Boot with Minror warnings or visual errors.
Default eZPB Admin Module Views Boot With Major warnings or errors per module view set.
eZ User, eZ SysInfo, eZ Site Manager Are the First 3 Upgraded Default eZPB Admin siteaccess module views to Run 98% without visual or noticeable issues.

Modules Tested with PHP 8.3

All modules have been tested, documented and bugfixed to run with known patterns of php4 code which still generate warnings and fatal errors upon usage beyond and including page loading.

Remaining work to provide full PHP 8.3+ Compatibility

The remaining work to test, bugfix and document all modules individually as PHP8 Compatible

Current efforts surround going through each admin and user module views per module and fixing all warnings and errors on initial page load. (Page load error free)
Next efforts surround going through each admin and user module views per module and fixing all usage / interaction / form submissions / CRUD operations php warnings and errors on normal module view Actions usage (Features usage error free). Most time consuming phase.
Follow up efforts surround going through each admin and user module views per module an additional time and making certain the actual output is sane and correct for the given database content and feature interactions (Actions; Feature usage accurate and valid results output to user every time). This will require additional documentation to ensure repeatable results.
Final efforts surround going through all module views with various error logging being monitored to capture debug, errors, warnings, any output that creates a log entry will be reviewed and if needed refactored as needed. This should be automated with testing software in the future.

Installation via Git & GitHub

Follow these steps to set up eZ Publish Basic via GitHub:

Clone the repository:

git clone https://github.com/se7enxweb/ezpublishbasic.git

Navigate to the project directory:
```
cd ezpublishbasic
```
Install dependencies:
```
 composer install
```

Installation via Composer & Packagist

Follow these steps to set up eZ Publish Basic via Composer:

Clone the latest release:

composer create-project se7enxweb/ezpublishbasic -s dev ezpublishbasic;
cd ezpublishbasic;

Configure your installation of the software package

Configure your environment:

Web Server setup a new virtual host for the website(s) that power this software package. There are two by default. User and Admin websites.
- You will require separate virtual hosts for www and admin domains.
Database Server
- You will require a new database and database user and password access configured.
Filesystem User and Group Permissions

Set up your database in your database server.
Update settings files as needed.

Update site name, domain hostnames for user and admin websites, default design, database name and connecting username and password settings all in the site.ini in bin/ini/override/site.ini

Initialize the application in your web browser. We recommend loading the admin site first but it doesn't matter much.

Default Admin Account in eZ Publish Basic

Username: 'admin'
Password: 'publish'

Example usage of user login view

Example usage via web browser using eZ User URL: https://basic.demo.ezpublish.one/user/login
Example usage via web browser using eZ Admin URL: https://admin.basic.demo.ezpublish.one/user/login

Note: Your work is now done. Enjoy the free software and a healthy snack. :)

Documentation

Further documentation can be read from the documentation directory README.

Software Features

eZ Publish Basic provides a feature rich cms based website building platform that is ready to use upon it's quick installation setup.

Learn more about eZ Publish Basic features in detail. Study our documentation, FEATURES.md.

PHP Compatability

For the latest information about the development of php 8 compatibility read our documentation, COMPATABILITY.md - eZ Publish Basic Module Compatibility with PHP8.x.

Module Documentation

For the latest detailed list of views in eZ Publish Basic read our documentation, MODULES.md.

Contributions

We are currently seeking others with eZ Publish 2 code improvements to share them with our project to grow the default installation feature set even further.

Community eZ Publish 2 Modules

The worldwide eZ community on the internet likely holds old copies of custom modules. Some community members may be willing to contribute their modules for inclusion in eZ Publish Basic.

How to Contribute

We welcome contributions from the community! To get involved:

Fork the repository.
Create a new branch for your feature or bugfix.
Submit a pull request.

Check out the Contributing Guidelines for more details.

Developed with ❤️ by 7x.

About (Original)

Originally released as eZ Publish Version 2 by eZ Systems (now Ibexa) in 1999, this CMS has a storied history of innovation.

In mid-2001, 7x began development based on eZ Community 2.x, a PHP/MySQL CMS derived from eZ Publish 2.2.x.

Notable Milestones:

Released (as is / example work in progress) eZ Community 2.3 around 2006.
Enhanced stability and refined CMS/e-commerce features for USA-based users. (Basis of USA States Support (eZ Region) code was implemented but not integrated)
This repository is a direct descendant of the deprecated ezcommunity2-contributions repository, restructured for simpler maintenance and support.

se7enxweb / ezpublishbasic

Maintainers

Details