This page contains information about how to set up a local development environment for BlueSpice.
Local development environment based on bluespice-deploy
A developer can use the default deployment stack and alter is to quickly set up a development environment. To do so, first clone the stack to your local machine and navigate into it:
git clone -b 5.2.x git@github.com:hallowelt/bluespice-deploy.git
cd bluespice-deploy/compose
Create a proper .env file from the .env.sample and alter/add the following lines:
DATADIR=~/workspace/REL1_43-5.2.x/data
CODEDIR=~/workspace/REL1_43-5.2.x/code
SMTP_HOST=mailhog
SMTP_PORT=1025
Create a docker-compose.overrides.yml file with the following content:
services:
wiki-installer:
image: docker.bluespice.com/bluespice-qa/wiki:latest
volumes:
- ${CODEDIR}:/app/bluespice/w/
wiki-web:
image: docker.bluespice.com/bluespice-qa/wiki:latest
volumes:
- ${CODEDIR}:/app/bluespice/w/
wiki-task:
image: docker.bluespice.com/bluespice-qa/wiki:latest
volumes:
- ${CODEDIR}:/app/bluespice/w/
mailhog:
image: mailhog/mailhog
container_name: mailhog
environment:
VIRTUAL_HOST: ${WIKI_HOST}
VIRTUAL_PATH: /_mailhog
VIRTUAL_PORT: 8025
VIRTUAL_DEST: /
This will make the stack use your local codebase from $CODEDIR and also expose a Mailhog web interface on $Wiki_HOST/_mailhog.
In addition, if you want to work with a custom build of the bluespice/wiki container, you can add an image: entry to the respective services. Example
wiki-installer:
image: bluespice/wiki:dev
...
wiki-web:
image: bluespice/wiki:dev
...
wiki-task:
image: bluespice/wiki:dev
...
or you set
BLUESPICE_WIKI_IMAGE=bluespice/wiki:dev
in your .env
