Skip to content

Commit

Permalink
docs: add usage of run-extra-commands command
Browse files Browse the repository at this point in the history
  • Loading branch information
bra-i-am committed Apr 4, 2024
1 parent c473596 commit f72ce46
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ tutor distro repository-validator
# Enabler commands
tutor distro enable-themes
tutor distro enable-private-packages

# Run extra commands
tutor distro run-extra-commands
```

### Documentation
Expand Down Expand Up @@ -240,6 +243,21 @@ The command will check the configuration for:
- INSTALL_EXTRA_FILE_REQUIREMENTS
- OPENEDX_EXTRA_SETTINGS

# Run tutor extra commands

You can run tutor extra commands by adding them into the **config.yml** in an attribute `DISTRO_EXTRA_COMMANDS` like this:

```yaml
DISTRO_EXTRA_COMMANDS:
- tutor plugins install mfe && tutor plugins enable mfe
- tutor plugins index add https://overhang.io/tutor/main
```
You can only insert commands enabled by the [Tutor CLI](https://docs.tutor.edly.io/reference/cli/index.html). Once you have added the commands you want to execute, you will need to run the following command:
```bash
tutor distro run-extra-commands
```

# Other Options

## How to add custom middlewares
Expand Down

0 comments on commit f72ce46

Please sign in to comment.