https://github.com/moodlebox/moodlebox
A Moodle server and Wi-Fi router on Raspberry Pi Zero 2w, 3, 4 and 5
https://github.com/moodlebox/moodlebox
access-point moodle moodle-server moodlebox offline raspberry raspberry-pi raspberry-pi-3 raspberry-pi-4 raspberry-pi-5 raspberry-pi-zero-2-w raspberrypi rpi3 rpi4 rpi5 wi-fi wi-fi-router wifi wifi-hotspot
Last synced: 3 months ago
JSON representation
A Moodle server and Wi-Fi router on Raspberry Pi Zero 2w, 3, 4 and 5
- Host: GitHub
- URL: https://github.com/moodlebox/moodlebox
- Owner: moodlebox
- License: agpl-3.0
- Created: 2016-08-06T17:05:30.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2025-03-23T11:07:02.000Z (3 months ago)
- Last Synced: 2025-03-29T12:09:00.148Z (3 months ago)
- Topics: access-point, moodle, moodle-server, moodlebox, offline, raspberry, raspberry-pi, raspberry-pi-3, raspberry-pi-4, raspberry-pi-5, raspberry-pi-zero-2-w, raspberrypi, rpi3, rpi4, rpi5, wi-fi, wi-fi-router, wifi, wifi-hotspot
- Language: Jinja
- Homepage: https://moodlebox.net/
- Size: 8.89 MB
- Stars: 126
- Watchers: 18
- Forks: 29
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Support: .github/support.yml
Awesome Lists containing this project
README
# MoodleBox
[](https://github.com/moodlebox/moodlebox/releases/latest)
[](https://github.com/moodlebox/moodlebox/releases/latest)
[](https://github.com/moodlebox/moodlebox/releases/)
[](https://github.com/moodlebox/moodlebox/commits/)
[](https://github.com/moodlebox/moodlebox/actions?query=workflow%3ACI)
[](https://www.paypal.me/moodlebox/50)
A Moodle server and Wi-Fi router on Raspberry Pi.
## MoodleBox Documentation
Visit the [MoodleBox web site][website] for more information about the MoodleBox features or any question about the usage of a MoodleBox.
__If you just want to use a MoodleBox, just [install it with Raspberry Pi Imager][install] on your Raspberry Pi Zero 2 W, 3A, 3B, 3B+, 4B, 400 or 5 and use it out of the box. Follow the instructions on the [MoodleBox web site][website].__
### Asking Support Questions
We have an active [discussion forum][forum] where users and developers can ask questions. Please don't use the GitHub issue tracker to ask questions.
## Building the MoodleBox disk image from scratch
If you just want to use a MoodleBox, __you don't need__ to build the MoodleBox disk image yourself. Just [install it with Raspberry Pi Imager][install] on your Raspberry Pi Zero 2 W, 3A, 3B, 3B+, 4B, 400 or 5 and use it out of the box. Follow the instructions on the [MoodleBox web site][website].
To build a MoodleBox from scratch with this script, you need a Raspberry Pi 3B, 3B+, 4B or 5.
1. Clone [Raspberry Pi OS (64-bit) Lite image](https://www.raspberrypi.com/software/operating-systems/#raspberry-pi-os-64-bit) on your microSD card.
1. Create a `ssh.txt` file on the `bootfs` partition with any content.
1. Create a `userconf.txt` file on the `bootfs` partition, and add the following line to it:
`moodlebox:$6$rmLgDblolU16oLmc$i7QzARV8o84tCDQA/Kq1xU3eYwPWlocqVmpFTcSWqAqiWJpFyTLd.g9W5ktDDh16rq5lwYG9wpHY224m5nHLk0`
1. Insert the microSD card into your Raspberry Pi.
1. Connect your Raspberry Pi to your Ethernet network and boot it.
1. [Install Ansible](https://docs.ansible.com/ansible/latest/installation_guide/index.html) on your computer. On macOS, use e.g. `brew install ansible`.
1. [Install `sshpass`](https://gist.github.com/arunoda/7790979) to enable passing SSH password to the Raspberry Pi. On macOS, use e.g. `brew tap esolitos/ipa; brew install sshpass`.
1. [Clone this repository][git] to your local drive.
1. Create a `keys` directory in the repository folder and copy your public key into it, under the name `id_rsa.pub`.
1. Get the IP address of your Raspberry Pi and change it in the `hosts.yml` file. Do not change anything else, unless you know what you're doing. You're on your own.
1. Run `ansible-playbook moodlebox.yml` from the repository folder.
1. Wait 15–50 minutes, depending on your Raspberry Pi model, SD card speed and Internet bandwidth. You're done.
### Overriding defaults
You can override any of the defaults configured in `default.config.yml` by creating a `config.yml` file and setting the overrides in that file. For example, you can change the MoodleBox main credentials and the timezone with something like:
moodlebox_username: 'myusername'
moodlebox_password: 'secret'
moodlebox_timezone: 'Australia/Perth'
Any variable can be overridden in `config.yml`; see the file `default.config.yml` for a list of available variables.
## Availability
The code is available at [https://github.com/moodlebox/moodlebox][git].
### Release notes
See [Release notes](https://github.com/moodlebox/moodlebox/blob/master/CHANGELOG.md).
## Sponsor
MoodleBox is sponsored by [E-learning Touch'](https://www.elearningtouch.com/) Moodle Partner.
## Thanks
- To Daniel Méthot, for the [idea of a MoodleBox](https://moodle.org/mod/forum/discuss.php?d=278493)
- To Christian Westphal, for the [first POC](https://moodle.org/mod/forum/discuss.php?d=331170) of a MoodleBox
- To the [Raspberry Pi Foundation](https://www.raspberrypi.org/), for a splendid small computer
- To [Martin Dougiamas](https://en.wikipedia.org/wiki/Martin_Dougiamas), for giving us Moodle, and to the [Moodle community](https://moodle.org/)
## License
Copyright © 2016 onwards, Nicolas Martignoni [email protected].
All contributions to this repository are licensed under AGPLv3 or any later version.
MoodleBox doesn't require a CLA (Contributor License Agreement). The copyright belongs to all the individual contributors. Therefore we recommend that every contributor adds following line to the header of a file, if they
changed it substantially:
```
@copyright Copyright © , ()
```
[website]: https://moodlebox.net
[download]: https://moodlebox.net/download
[forum]: https://discuss.moodlebox.net/
[git]: https://github.com/moodlebox/moodlebox
[install]: https://moodlebox.net/en/help/copy-the-disk-image-on-a-sd-card/