README

Yet another sleek simple fast CMS with an effortless template and plugin environment

Install

1. Navigate to your project folder

Open terminal and navigate to your project folder:

cd path/to/your/ivy/project

2. Download ivy files

Use Composer to create a new project with ivy:

composer create-project joepdooper/ivy .

3. Configure

Rename the example.env file to .env.

4. Setup

Option A - Start the containers (recommended)

If you have Docker or Podman run:

./vendor/bin/cultivate

Option B - Start webserver and set up the database

Create a database for ivy and import the provided ivy.sql file:

mysql -u your_database_username -p your_database_name < docker/mysql/ivy.sql

If you are not using the provided Docker or Podman compose files, update the .env file with your database credentials and make sure your web server points to the public/ folder inside this project 000-default.conf. Additionally, ensure that the public/ and cache/ folders have the proper permissions so your web server can read and write to them as needed.

Login

Accessing the backend

To access the "backend" for the first time, after the installation, follow these steps:

1. Navigate to yourserver.com/admin/login (user icon)
2. Use the credentials admin@localhost.test and 00000
3. Upon successful login, you will be directed to the profile page with super_admin rights

Changing email and password

Open the .env file and update it with your mailbox credentials. If you've modified the .env file, follow these steps:

1. Upon login, on the profile page, modify and submit your email address to initiate the email change process
2. After successfully changing your email address, go to yourserver.com/admin/logout to log out (logout icon)
3. Finally, navigate to yourserver.com/admin/reset to initiate the password reset process

Documentation

Documentation coming up