documentation update
This commit is contained in:
		
							parent
							
								
									7e877465a6
								
							
						
					
					
						commit
						5d2281b713
					
				
							
								
								
									
										24
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										24
									
								
								README.md
									
									
									
									
									
								
							@ -11,20 +11,20 @@ Master Repo: https://git.4lt.ca/4lt/novaconium
 | 
			
		||||
 | 
			
		||||
## Getting Started
 | 
			
		||||
 | 
			
		||||
### Installation 
 | 
			
		||||
### Installation (docker)
 | 
			
		||||
 | 
			
		||||
```bash
 | 
			
		||||
mkdir project_name;
 | 
			
		||||
cd project_name;
 | 
			
		||||
# Native
 | 
			
		||||
 | 
			
		||||
composer require 4lt/novaconium
 | 
			
		||||
# Composer
 | 
			
		||||
docker run --rm --interactive --tty --volume $PWD:/app composer require 4lt/novaconium
 | 
			
		||||
 | 
			
		||||
docker run --rm --interactive --tty --volume $PWD:/app composer:latest require 4lt/novaconium
 | 
			
		||||
cp -R vendor/4lt/novaconium/defaults/App/ .
 | 
			
		||||
cp -R vendor/4lt/novaconium/defaults/public/ .
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
#### Compose install (debian)
 | 
			
		||||
### Install Composer on Debian
 | 
			
		||||
 | 
			
		||||
```bash
 | 
			
		||||
sudo nala install curl php-cli php-mbstring git unzip
 | 
			
		||||
@ -33,6 +33,20 @@ sudo php composer-setup.php --install-dir=/usr/local/bin --filename=composer
 | 
			
		||||
rm composer-setup.php
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## 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
 | 
			
		||||
    ],
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Documentation
 | 
			
		||||
 | 
			
		||||
* [Docker Setup](https://git.4lt.ca/4lt/novaconium)
 | 
			
		||||
 | 
			
		||||
@ -1,72 +1,66 @@
 | 
			
		||||
# Getting Started With Docker
 | 
			
		||||
# Docker Cheatsheet (for Novaconium)
 | 
			
		||||
 | 
			
		||||
## Clone Docker Cookbooks
 | 
			
		||||
## Compose update project
 | 
			
		||||
 | 
			
		||||
[Github Docker Compose Cookbooks](https://github.com/nickyeoman/docker-compose-cookbooks)
 | 
			
		||||
```docker run --rm --interactive --tty --volume $PWD:/app composer:latest update```
 | 
			
		||||
 | 
			
		||||
## Sample Docker Compose File
 | 
			
		||||
 | 
			
		||||
```bash
 | 
			
		||||
git clone git@github.com:nickyeoman/docker-compose-cookbooks.git /docker-compose-cookbooks
 | 
			
		||||
```
 | 
			
		||||
services:
 | 
			
		||||
 | 
			
		||||
## Setup Docker Compose File
 | 
			
		||||
  corxn: 
 | 
			
		||||
    image: ${CORXN_IMAGE}
 | 
			
		||||
    restart: always
 | 
			
		||||
    volumes:
 | 
			
		||||
      - "./novaconium:/data"
 | 
			
		||||
      - "./config/php.ini:/usr/local/etc/php/php.ini"
 | 
			
		||||
    networks:
 | 
			
		||||
      - my_internal
 | 
			
		||||
      - proxy
 | 
			
		||||
    ports:
 | 
			
		||||
      - 8000:80
 | 
			
		||||
 | 
			
		||||
Read the sample extends file of /docker-compose-cookbooks/phpcontainer/sample-extends.yml 
 | 
			
		||||
  mariadb:
 | 
			
		||||
    image: ${MARIADB_IMAGE}
 | 
			
		||||
    restart: always
 | 
			
		||||
    command: --transaction-isolation=READ-COMMITTED --binlog-format=ROW --innodb-file-per-table=1 --skip-innodb-read-only-compressed
 | 
			
		||||
    environment:
 | 
			
		||||
      - MARIADB_DATABASE=${DB}
 | 
			
		||||
      - MARIADB_PASSWORD=${DB_PASSWORD}
 | 
			
		||||
      - MARIADB_ROOT_PASSWORD=${DB_ROOT_PASSWORD}
 | 
			
		||||
      - MARIADB_USER=${DB_sUSER}
 | 
			
		||||
    volumes:
 | 
			
		||||
      - ${VOL_PATH}/db:/var/lib/mysql
 | 
			
		||||
    networks:
 | 
			
		||||
      - my_internal
 | 
			
		||||
 | 
			
		||||
```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
 | 
			
		||||
networks:
 | 
			
		||||
  proxy:
 | 
			
		||||
    external: true
 | 
			
		||||
  my_internal:
 | 
			
		||||
    driver: bridge
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## ENV File
 | 
			
		||||
### ENV File
 | 
			
		||||
 | 
			
		||||
Then setup the .env file, which should look something like this:
 | 
			
		||||
The .env file should look something like this:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
COOKBOOK=/docker-compose-cookbooks
 | 
			
		||||
COMPOSE_PROJECT_NAME=myProject
 | 
			
		||||
CORXN_IMAGE=4lights/corxn:latest
 | 
			
		||||
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
 | 
			
		||||
DB=mydbname
 | 
			
		||||
DB_ROOT_PASSWORD=ChangeThisPassword0123456789ABCD
 | 
			
		||||
DB_PASSWORD=AlsoChangeThisPassword0123456789
 | 
			
		||||
DB_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```
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user