Before you can start your own notification service, you need to set up your environment variables which store your Moodle credentials. The following steps will guide you through this process. At the end you should have your .env file ready!

info

The Notification Service uses a passwordless authentication! Learn more about this here

📁 Create your file

Create a new file on you local filesystem and name it .env. In some cases your file will disappear immediately after you have created it. In this case change your filemanager's settings to display hidden files.

Copy and paste code from this page - section "Only required variables".

Set a strong secret for JWT_SECRET. You can use password generators like from Lastpass or pwgen on linux.

If you choose to run the service with docker, you can keep the value of MONGO_HOST. If not you will find the missing steps in the according deploy-on guides.

tip

You can use .env to initially configure your service, so you do not have to open the web interface as long as you do not want to update something. Click here for more.

🏫 Generate your new Moodle-Token

For this step, you need an existing Moodle account (that can be yours). This account needs access to all courses you want to receive notifications from.

We created an online tool, to make it as simple as possible for you: Open fmdb.tjarbo.me and fill out the form to generate all required environment variables. Note, that no data will be stored or send to any other server than the submitted moodle server! Your credentials will be send to the official API of your moodle instance to receive a new token. You need the displayed results for the next step.

info

Right now, SSO is not official supported ☹️ We need to figure out how to implement this authentication method. Lernraum Berlin ? -> Click here

⏭️ What next ?

Now you are ready to deploy your Notification Service. We have created multiple instructions for different cloud providers and methods.

tip

Many of the chosen providers have a discount for students!