genular/simon repository overview

⁠Explanation

Directory ./base_image contains scripts necessary to create parent docker image. Usage:

LANG=en_US.UTF-8 sudo ./make_image.sh

Command pre-installs basic genular dependencies from a Debian distribution and compile custom image out of it, that is than used latter on in Dockerfile.

⁠Steps needed to publish parent genular image

After build is finished using ./make_image.sh image will be compressed inside ./base_image/images directory.

⁠1. Import local tar image

Command: Replace FILE_NAME with actual filename.

sudo cat ./FILE_NAME.tar | sudo docker import - genular/parent:master

Check if image is properly imported

## List all images
docker image ls -a

⁠1.1 Login to repository if not already logged-in

cat ~/my_password.txt | docker login --username foo --password-stdin

⁠2. Push your image to on-line repository

docker push genular/parent:master

⁠2.1 or upload to CDN

rclone copy ./genular.tar genular-spaces:genular/docker-parent-images

⁠Steps needed to publish child genular SIMON image

Auto-build is configure on Docker Hub⁠. Whenever new change is detected in repository container genular/simon:latest will be build-ed automatically.

To do it manually first build docker image from Dockerfile:

⁠1. Check/Adjust configuration variables in Dockerfile

You can get example of configuration JSON by executing following command cd simon-backend/server/backend && composer generate-docker-config This will create a new file: documentation/docker_images/configuration.json where you can add/remove custom configuration variables and place it in ./configuration.example.json

⁠2. Build docker image

Remove --network=host if needed. docker build --no-cache --network=host --tag "genular/simon:latest" --file ./Dockerfile .

⁠3. Running SIMON Container

In order to run a test instance of SIMON we first need to prepare the environment. If you finished installing docker please continue.

Lets pull the genular/simon⁠ image from Docker Hub⁠. Then we will run a docker container with appropriately mounted volumes and port mapping. By default the container would run with a local file-system inside of it.

After you installed docker and its running, please open your favorite Terminal and run the command below. If on Windows - open Windows Power Shell

# Important: if you are using Windows replace newline separators in the command: "\" with "`"
# To use custom directory as file-system backend: --volume /mnt/genular/simon-backend/SHARED_DATA:/mnt/usrdata \
docker run --rm --network=host \
    --detach \
    --name genular \
    --tty \
    --interactive \
    --env IS_DOCKER='true' \
    --env TZ=America/Los_Angeles \
    --volume genular_data:/mnt/usrdata \
    --publish 3010:3010 \
    --publish 3011:3011 \
    --publish 3012:3012 \
    --publish 3013:3013 \
    genular/simon:latest

Once command is executed and the container is started you can open SIMON on http://localhost:3010 and create your account.

• If you get asked please allow connections through your Windows Firewall.

To publish it on Docker Hub⁠ use same steps as above.

⁠Helpers

• SSH into a running container docker exec -it genular /bin/bash
• List all running ones docker ps
• Stop image docker stop genular
• To delete specific image docker rmi IMAGE_ID
• Prune all images: docker system prune -a
• Delete docker volume: docker volume rm genular_data