Getting started

Assuming you have docker up and running. Check issues below or this gist for more help.

clone (or symlink) Kinetic/N3 app into this project - N3 catalogue switch to (my branch)[https://github.com/pawlik/N3/tree/docker-version] or if (this PR is accepted)[https://github.com/NexwayGroup/N3/pull/2711] you can use whatever branch in sync with it

docker-compose up -d

this should start all the containers (you can attach yourself to all containers logs with docker-compose logs).

now preffered way to install N3 would be: docker-compose run php shell/bulbulator/bulbulate.sh

all necessary envs are defined in docker-compose.yml on php container

ENVs

defaults sit's in (.env.defaults)[.env.defaults] and those should be as generic as possible and sufficient enough to allow you to run all required docker images (assuming you'll point kinetic.docker.dev to your localhost in /etc/hosts)

You can override those ENVs in .env.local, but don't commit changes to this file (it's in repo, because docker compose will fail if we define non existing env file in (docker-compose.yml)[docker-compose.yml])

For one time ENV set up, use -e switch: docker-compose run -e DROP_DB=true php shell/bulbulator/bulbulate.sh

Xdebug

it has some annoying issue - when debugging on PHPStorm10 - it triggers Fatal error about uninitialized static variable whenever you try to step-over such statement like here

Current workaround: set up breakpoint behind it, cross your fingers and press F9 (there's a lot of such places, so be extra careful) - this makes it little bit PITA to treat as dev env yet.

Things to improve:

• fix xdebug issues
• fulfillment doesn't work -
  • need to check networking stuff with docs vs our VPN (check DNS config for docker-compose)
  • or (maybe preferred) use tunnel service (localtunnel.me)
• move BBL envs from docker-compose.yml to env file
• Bulbulating should probably be run outside of php container (this is complex issue)
• after installation redis config should be automatically changed to redis
• composer cache seems to ignore cache's from data volume
• after first compose install it uses cache, but after restarting containers probably not
• composer has some issues with github authentication (token can help?)