diff --git a/README.md b/README.md index 56fcc5e..8034a15 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ This is a setup for `docker compose` to try out a complete ClusterCockpit Applic It creates containers for: * mysql -* influxdb * php-fpm * nginx +* influxdb (only in dev mode) * phpmyadmin (only in dev mode) Ports and Passwords are configured in `.env`. @@ -55,13 +55,15 @@ To reuse an existing Symfony tree at `./data/symfony` you may change the environ * By default, this also uses prepared fixture data for databases. In order to use an existing database, changes in `.env` and `docker-compose.yml` are required (see below). ### Setup +This description assumes you will let the docker setup initialize the symfony tree and data fixtures for you. If not using an existing database, the fixture data needs to be prepared before the first start of the containers: * `$ cd data` -* `$ ./init.sh` +* `$ ./init.sh dev` + In `.env`, change the following variables under `APP` * `APP_ENVIRONMENT` to `dev` -After that from the root of the repository you can start up the containers with: +After that from the root of the repository you can start up the containers with (use -d switch to startup in detached mode): * `docker-compose -f docker-compose.yml -f docker-compose-dev.yml up` * Wait... and wait a little longer @@ -69,7 +71,7 @@ After the initial setup you have to: * Comment or delete the line `- ${DATADIR}/sql:/docker-entrypoint-initdb.d` for `cc-db` to disable initialisation of the MySQL database. * Set `APP_CLUSTERCOCKPIT_INIT` to `false` in the .env file -On subsequent start of the containers you will then use the persisted volume data located in the `./data` directory. +On subsequent start of the containers you will then reuse the persisted volume data located in the `./data` directory. By default, you can access ClusterCockpit in your browser at `http://localhost`. If `NGINX_PORT` environment variable was changed, `use http://localhost:$PORT`. @@ -80,4 +82,4 @@ If default database fixture were used, the credentials for admin user are: * User: `admin` * Password: `AdminDev` -You can shutdown the containers by pressing `CTRL-C`. +You can shutdown the containers by pressing `CTRL-C` if not started in detached mode.