Skip to content

Latest commit

 

History

History
96 lines (67 loc) · 3.54 KB

README.md

File metadata and controls

96 lines (67 loc) · 3.54 KB

Docker's version of amc2moodle

A docker version of amc2moodle is available and it starts a daemon server to automatically execute amc2moodle or moodle2amc.

Alternatively, it is also possible to run an interactive shell in the docker to recover standard amc2moodle command line interface.

Installation

The container can be downloaded using the following command

docker pull ghcr.io/nennigb/amc2moodle:latest

The container proposes to mount two volumes: - /tmp/work (mandatory mount) that must be link to a specific folder on the host computer - /tmp/daemon (optional mount) that store the log file of the daemon

For instance, the container can be run in CLI (in detached mode) with the following command (*by replacing DIRA and if necessary DIRB):

docker run --name amc2moodle -d -v "DIRA:/tmp/work" -v "DIRB:/tmp/daemon" ghcr.io/nennigb/amc2moodle

NB: DIRA and DIRB must be absolute paths.

it is strongly recommended to use only empty folder with no critical contents for DIRA and DIRB.

In case of permission issue to mount folder(s), consider adding option --user "$(id -u):$(id -g)" such as the running command is:

docker run --name amc2moodle --user "$(id -u):$(id -g)" -d -v "DIRA:/tmp/work" -v "DIRB:/tmp/daemon" ghcr.io/nennigb/amc2moodle

The container can be stopped using the following command

docker stop amc2moodle

Usage as daemon/server (automatic building)

We assume that DIRA has been mounted and bound to /tmp/work.

Folder DIRA can be populated with every required data to run amc2moodle or moodle2amc such as

DIRA
├── ...
├── a_amc2moodle.tex
├── b_moodle2amc.xml
└── ...

The server will automatically detects the files and run the appropriate script:

  • to run amc2moodle the main LaTeX file must be rename such as the end the name ends with amc2moodle.tex (such as the file a_amc2moodle.tex)
  • to run moodle2amc the main LaTeX file must be rename such as the end the name ends with moodle2amc.xml (such as the file b_moodle2amc.xml)

After the run, the folder will contain additional files provided by the daemon/server and the script:

DIRA
├── ...
├── a_amc2moodle.tex
├── a_amc2moodle.tex.lock
├── a_amc2moodle_amc2moodle.log
├── b_moodle2amc.xml
├── b_moodle2amc.xml.lock
├── b_moodle2amc_moodle2amc.log
└── ...

Logfiles (*.log) are provided by the amc2moodleor moodle2amc scripts and allows to check if everything is fine.

Lockfiles (*.lock) are provided by the daemon/server. Running a new execution could be obtain by removing one of this files.

In addition, if the DIRB directory has been mounted, it will contain detailed logfiles of the daemon and could be use for debug.

Advanced usage with command line

Since the container has been started with for instance the procedure given above. A command line within the docker can be obtained by running the following command:

docker exec -it amc2moodle /bin/bash

With this shell, classical amc2moodle and moodle2amc commands are available (see here for usable syntax).

NB:

  • this command could be adapted depending on the name of the executed container.
  • execution of the previous does not stop the server/daemon.
  • the files should be visible from the docker i.e. in DIRA folder or in another given volume
  • the command line interface could also be run without starting the amc2moodle daemon (docker run vs docker exec)