diff --git a/README.md b/README.md index 6a63d75..83e00f8 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,19 @@ Master Repo: https://git.4lt.ca/4lt/novaconium mkdir project_name; cd project_name; composer require 4lt/novaconium -cp -R vendor/4lt/novaconium/examples/App/ . -cp -R vendor/4lt/novaconium/examples/public/ . +cp -R vendor/4lt/novaconium/defaults/App/ . +cp -R vendor/4lt/novaconium/defaults/public/ . ``` + +#### Compose install (debian) + +```bash +sudo nala install curl php-cli php-mbstring git unzip +curl -sS https://getcomposer.org/installer -o composer-setup.php +sudo php composer-setup.php --install-dir=/usr/local/bin --filename=composer +rm composer-setup.php +``` + +## Documentation + +* [Docker Setup](https://git.4lt.ca/4lt/novaconium) \ No newline at end of file diff --git a/defaults/App/controllers/index.php b/defaults/App/controllers/index.php index d0182fa..132b1a6 100644 --- a/defaults/App/controllers/index.php +++ b/defaults/App/controllers/index.php @@ -1,2 +1,2 @@ render('index.html.twig'); \ No newline at end of file +view('index'); diff --git a/docs/docker.md b/docs/docker.md new file mode 100644 index 0000000..59dfe8c --- /dev/null +++ b/docs/docker.md @@ -0,0 +1,72 @@ +# Getting Started With Docker + +## Clone Docker Cookbooks + +[Github Docker Compose Cookbooks](https://github.com/nickyeoman/docker-compose-cookbooks) + +```bash +git clone git@github.com:nickyeoman/docker-compose-cookbooks.git /docker-compose-cookbooks +``` + +## Setup Docker Compose File + +Read the sample extends file of /docker-compose-cookbooks/phpcontainer/sample-extends.yml + +```bash +# ensure docker-compose exists +[[ -f docker-compose.yml ]] || echo "services:" > docker-compose.yml + +# PHP container +tail -n+2 /docker-compose-cookbooks/phpcontainer/sample-extends.yml >> docker-compose.yml + +# PHP settings +cp -r /docker-compose-cookbooks/phpcontainer/config . + +# Set project directory +sed -i 's|- "./project:/data"|- "./:/data"|' docker-compose.yml + +# Mariadb container +tail -n +2 /docker-compose-cookbooks/mariadb/sample-extends.yml >> docker-compose.yml + +``` + +## ENV File + +Then setup the .env file, which should look something like this: + +``` +COOKBOOK=/docker-compose-cookbooks +COMPOSE_PROJECT_NAME=myProject +TZ=America/Vancouver +VOL_CONFIG_PATH=/data/myProject/config +VOL_PATH=/data/myProject/data + +# PHP Container +PHPCONTAINER_IMAGE=4lights/phpcontainer:latest + +# MariaDB +MARIADB_IMAGE=mariadb:latest +MARIADB_MARIADB_DATABASE=mydb +MARIADB_MARIADB_ROOT_PASSWORD=ChangeThisPassword0123456789ABCD +MARIADB_MARIADB_PASSWORD=AlsoChangeThisPassword0123456789 +MARIADB_MARIADB_USER=dbuser +``` + +## APP Database config + +Open the /App/config.php file and change the database section to match the above: + +```php +'database' => [ + 'host' => 'mariadb', + 'name' => 'mydb', + 'user' => 'dbuser', + 'pass' => 'AlsoChangeThisPassword0123456789', + 'port' => 3306 + ], +``` + + +## Start Docker + +```docker compose up -d```