Installation
Installing via Docker
If you have Docker installed and running on your operating system,
you can run commands that will build a new image from a reference Linux
distribution. NGINX, PHP, Git will be installed into this image, and the
latest version of this System will be uploaded through the repository.
Then it will be enough to open a browser and type the address
127.0.0.1:8080
where you will see the System installation page.
Run the following commands to start the system via Docker:
mkdir docker-effcore
cd docker-effcore
git clone https://github.com/effectivecore/docker.git .
./build.sh
Installing via Composer
Create a new project in the current directory:
composer create-project effcore/core:dev-main .
Installing all third-party libraries in the case when the project
is deployed from the archive:
composer install
An example of installing a library of type effcore-bundle
or effcore-module
(the library
will be placed in the directory /modules
):
composer require effcore/examples:dev-main
An example of installing a universal third-party library (the library
will be placed in the directory /modules/vendors/packages
):
composer require Vendor\Model
Installing via bundle archive
Actions before installation:
- When you will use MySQL to store data, check if you have
credentials for it (login, password, database name).
If you do not have credentials, check if you have the database and
the user account for it via web hosting service panel (for example
DirectAdmin, ISPmanager, cPanel, Plesk and others).
If you do not have database, create one
and also user account to work with it.
- Check if you have credentials (hostname, login, password)
for FTP service which running on web hosting server.
If you do not have credentials, create new FTP user account
or reset the password of an existing account via web hosting service panel.
- Check if you have FTP Client for transfer files
to the web server. For example: Transmit (mac), Cyberduck (mac|win),
FileZilla (mac|win|linux) and other.
- Check if you enabled visibility of hidden files in the archiver,
operating system and FTP Client.
Actions for installations:
- Download the distribution kit of the system in archive from the
official site of this project.
- Unpack archive of the system to some local directory.
All files should be unpacked (including invisible files like
.htaccess
and other).
If you cannot see the invisible files in your archiver, make them visible.
If you cannot see the invisible files in your OS, make them visible. - Establish a connection with the web server via FTP protocol.
It is recommended to use the "SFTP" or "FTP with implicit SSL" or
"FTP with TSL/SSL".
- Via FTP client go to the web root directory on the web server
and copy all files of this system from the local directory
into web root.
- Open a web browser and go to your domain (which you
will use to deploy your site).
- If PHP is enabled you will see installation page of the system.
- If some required PHP modules are missing, you will receive
a message about which modules should be enabled.
Through the web hosting service panel, you can enable the missing
modules and continue the installation.
For the first time also recommended to enable
display_errors
,
log_errors
and set error_reporting
to E_ALL
.