tutor dev

Run Open edX locally with development settings

tutor dev [OPTIONS] COMMAND [ARGS]...

bindmount

Copy the contents of a container directory to a ready-to-bind-mount host directory

tutor dev bindmount [OPTIONS] SERVICE PATH

Arguments

SERVICE

Required argument

PATH

Required argument

createuser

Create an Open edX user and interactively set their password

tutor dev createuser [OPTIONS] NAME EMAIL

Options

--superuser

Make superuser

--staff

Make staff user

-p, --password <password>

Specify password from the command line. If undefined, you will be prompted to input a password

Arguments

NAME

Required argument

EMAIL

Required argument

dc

Direct interface to docker-compose. This is a wrapper around docker-compose. Most commands, options and arguments passed to this command will be forwarded as-is to docker-compose.

tutor dev dc [OPTIONS] COMMAND [ARGS]...

Arguments

COMMAND

Required argument

ARGS

Optional argument(s)

exec

Run a command in a running container. This is a wrapper around docker-compose exec. Any option or argument passed to this command will be forwarded to docker-compose. Thus, you may use -e to manually define environment variables.

tutor dev exec [OPTIONS] ARGS...

Arguments

ARGS

Required argument(s)

importdemocourse

Import the demo course

tutor dev importdemocourse [OPTIONS]

init

Initialise all applications

tutor dev init [OPTIONS]

Options

-l, --limit <limit>

Limit initialisation to this service or plugin

logs

View output from containers. This is a wrapper around docker-compose logs.

tutor dev logs [OPTIONS] [SERVICE]...

Options

-f, --follow

Follow log output

--tail <tail>

Number of lines to show from each container

Arguments

SERVICE

Optional argument(s)

reboot

This is more than just a restart: with reboot, the platform is fully stopped before being restarted again

tutor dev reboot [OPTIONS] service

Options

-d, --detach

Start in daemon mode

Arguments

service

Optional argument(s)

restart

Specify ‘openedx’ to restart the lms, cms and workers, or ‘all’ to restart all services. Note that this performs a ‘docker-compose restart’, so new images may not be taken into account. It is useful for reloading settings, for instance. To fully stop the platform, use the ‘reboot’ command.

tutor dev restart [OPTIONS] service

Arguments

service

Optional argument(s)

run

Run a command in a new container. This is a wrapper around docker-compose run. Any option or argument passed to this command will be forwarded to docker-compose. Thus, you may use -v or -p to mount volumes and expose ports.

tutor dev run [OPTIONS] ARGS...

Arguments

ARGS

Required argument(s)

runserver

Run a development server

tutor dev runserver [OPTIONS] [OPTIONS]... SERVICE

Arguments

OPTIONS

Optional argument(s)

SERVICE

Required argument

settheme

Assign a theme to the LMS and the CMS. To reset to the default theme , use ‘default’ as the theme name.

tutor dev settheme [OPTIONS] THEME_NAME

Options

-d, --domain <domains>

Limit the theme to these domain names. By default, the theme is applied to the LMS and the CMS, both in development and production mode

Arguments

THEME_NAME

Required argument

start

Run all or a selection of services. Docker images will be rebuilt where necessary.

tutor dev start [OPTIONS] service

Options

-d, --detach

Start in daemon mode

Arguments

service

Optional argument(s)

stop

Stop a running platform

tutor dev stop [OPTIONS] service

Arguments

service

Optional argument(s)