Setup containers

1. Open a terminal and change working directory to the root of the project folder.
2. If you want to serve on custom ports or database credentials, modify in docker-compose.yml

3. Deploy the docker images and services

   # Set up mysql, nginx and app services:
   docker compose up -d --build

Setup domain

1. Uncomment and point app.baseURL in .env to the root url of your server. eg: http://esp32.your-domain.com/

   app.baseURL = ''

2. Ensure database connection variables uncommented and correctly set in .env

   database.default.hostname = db
   database.default.database = esp32_db
   database.default.username = esp32_user
   database.default.password = esp32_pass
   database.default.DBDriver = MySQLi
   database.default.DBPrefix =
   database.default.port = 3306

Setup Database

1. Run the migration to create the database tables. See Database Migrations for more info. or Run:

   # phpmyadmin: http://localhost/phpmyadmin
   
   # using docker app container, prefix commands with docker exec -it esp32_app
   docker exec -it esp32_app php spark migrate --all
      
   # setup demo user (admin@esp32.io:admin) and devices
   docker exec -it esp32_app php spark db:seed DemoSeeder

Access Rights

1. Give valid permissions to writable folder and subfolders

   # This will add permissions, use valid user, commonly www-data for apache2 servers
   sudo chown -R www-data writable

Done

You should now be able to see a correctly setup instance when you navigate to: http://esp32.your-domain.com/

Verify

1. The Login controller is a clone of Shield's, this prevents the custom login page from being overwritten.

   Ensure Controllers\LoginController::loginView() matches CodeIgniter\Shield\Controllers\LoginController::loginView() .

Notes

1. Usfull docker commands:

   docker compose exec db mysql -uroot -proot -e "SELECT User,Host FROM mysql.user;"
   docker compose exec db mysql -uroot -proot -e "SHOW DATABASES;"
   docker compose exec db mysql -uroot -proot -e "USE esp32_db; SHOW TABLES;"
   
   # Start all services defined in docker-compose.yml in detached mode
   docker compose up -d
   
   # Build (or rebuild) images and start services in detached mode
   docker compose up -d --build
   
   # Stop and remove containers, networks, and default resources
   docker compose down
   
   # Stop and remove containers, networks, AND associated named volumes
   docker compose down -v
   
   # change environment to a docker container, to close type; exit
   # use either container name or ID
   docker exec -it esp32_app /bin/bash
   
   # directory on host to volumes
   ls /var/lib/docker/volumes/esp32_appdata/_data/
   
   # list volumes
   docker volume ls
   
   # remove volume (container has to be shut down)
   docker volume rm esp32_appdata

2. TIP: Temporary enable error printing:

   nano app/Config/Boot/production.php
   # Change:
   ini_set('display_errors', '0');
   # To:
   ini_set('display_errors', '1');

3. ERROR: Call to a member function getErrors() on null

   # If you encounter a php error during login, likely reason is a glitch with shield.
   # Try the following commands in the root of the project using the cli:
   
   composer require codeigniter4/shield:^1.1
   composer update