Repository files navigation

This Ansible playbook installscodam-web-greeter on a 42 network cluster computer. It is intended to be used by IT staff at 42 schools to install the greeter theme on all cluster computers at once without too much effort.

Before starting, make sure npm is installed on your cluster computers. This is required for the build process of codam-web-greeter.

Add the following to the roles in yourrequirements.yml file in youransiblecluster repository:

roles:  -name:codam.webgreetersrc:git+https://github.com/codam-coding-college/ansible-codam-web-greeter.gitversion:v1.5.3

It is recommended to change the version specified to the latest one from theReleases page. Please note that this version is specific to this playbook and does not necessarily match the version of the codam-web-greeter itself.

Then run the following command to install the role:

ansible-galaxy install -r requirements.yml

Modify thevariables using thevars/all.yml file in youransiblecluster repository to your liking. The one you most likely want to change is thecodam_web_greeter_data_server_url variable to point to your own data server.

⚠️ If using iMacs with T2 chips, set theddcci_backlight_support variable tofalse to avoid issues with the ddcci-backlight kernel module.

Add the role to yoursite.yml playbook as the last role executed (do not define tags here, this is unneccessary and is a mistake 42 made for all the other roles):

roles:...  -{ role: codam.webgreeter }

Congratulations, the codam-web-greeter will now be installed on your cluster computers when you run thesite.yml playbook! You can run it with the tagcodam.webgreeter to only run the steps for the codam-web-greeter specifically.

⚠️ Do not run the playbook on all cluster computers at once without testing it first on a testing machine. Your campus setup could potentially break, resulting in students not being able to log in and changes that can not easily be reverted.

Now, the following is optional but recommended: add your campus's logo to thecampus_files directory in youransiblecluster repository. The logo should be namedlogo.png and be placed incampus_files/usr/share/codam/web-greeter/. It will then get copied to the cluster computer and displayed by the login screen.

However, keep in mind that most campuses feature their logo already in the wallpaper used by the login screen provided by 42/Ubuntu. In this case, the logo would be displayed twice by the login screen. It is recommended to remove the logo from your login screen wallpaper or to use a custom wallpaper without the logo (defined in thelogin_wallpaper_path variable) to avoid this.

Using this feature over the logo embedded in the wallpaper has the advantage that the logo can be shifted around and resized more easily when required by the login screen's user interface.

It is also possible to specify a default user image in case the user's~/.face file is not present in their home folder. This image should be nameduser.png and be placed in the same directory as the logo. The default 42 user image can be foundhere. If no default user image is present on the system, no image will be displayed on the lock screen at all and it will just display the student's name.