tutor local
Run Open edX locally with docker-compose
tutor local [OPTIONS] COMMAND [ARGS]...
copyfrom
Copy files/folders from a container directory to the local filesystem.
tutor local copyfrom [OPTIONS] SERVICE CONTAINER_PATH HOST_PATH
Arguments
- SERVICE
Required argument
- CONTAINER_PATH
Required argument
- HOST_PATH
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 local dc [OPTIONS] COMMAND [ARGS]...
Options
- -m, --mount <mounts>
Bind-mount a folder from the host in the right containers. This option can take two different forms. The first one is explicit: ‘service1[,service2…]:/host/path:/container/path’. The other is implicit: ‘/host/path’. Arguments passed in the implicit form will be parsed by plugins to define the right folders to bind-mount from the host.
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 local exec [OPTIONS] ARGS...
Arguments
- ARGS
Required argument(s)
launch
Configure and run Open edX from scratch
tutor local launch [OPTIONS]
Options
- -m, --mount <mounts>
Bind-mount a folder from the host in the right containers. This option can take two different forms. The first one is explicit: ‘service1[,service2…]:/host/path:/container/path’. The other is implicit: ‘/host/path’. Arguments passed in the implicit form will be parsed by plugins to define the right folders to bind-mount from the host.
- -I, --non-interactive
Run non-interactively
- -p, --pullimages
Update docker images
logs
View output from containers. This is a wrapper around docker-compose logs.
tutor local 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 local 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 local 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 local run [OPTIONS] ARGS...
Options
- -m, --mount <mounts>
Bind-mount a folder from the host in the right containers. This option can take two different forms. The first one is explicit: ‘service1[,service2…]:/host/path:/container/path’. The other is implicit: ‘/host/path’. Arguments passed in the implicit form will be parsed by plugins to define the right folders to bind-mount from the host.
Arguments
- ARGS
Required argument(s)
start
Run all or a selection of services. Docker images will be rebuilt where necessary.
tutor local start [OPTIONS] service
Options
- --skip-build
Skip image building
- -d, --detach
Start in daemon mode
- -m, --mount <mounts>
Bind-mount a folder from the host in the right containers. This option can take two different forms. The first one is explicit: ‘service1[,service2…]:/host/path:/container/path’. The other is implicit: ‘/host/path’. Arguments passed in the implicit form will be parsed by plugins to define the right folders to bind-mount from the host.
Arguments
- service
Optional argument(s)
status
Print status information for containers
tutor local status [OPTIONS]
stop
Stop a running platform
tutor local stop [OPTIONS] service
Arguments
- service
Optional argument(s)
upgrade
Perform release-specific upgrade tasks. To perform a full upgrade remember to run launch.
tutor local upgrade [OPTIONS]
Options
- --from <from_release>
- Options
ironwood | juniper | koa | lilac | maple | nutmeg