update_motd/README.md

55 lines
1.7 KiB
Markdown
Raw Normal View History

2023-07-19 21:11:53 +00:00
update_motd
2023-04-03 16:53:42 +00:00
=========
> This repository is only a mirror. Development and testing is done on a private gitlab server.
2023-04-03 16:34:58 +00:00
2023-04-03 21:24:24 +00:00
This role enables you to set a cool motd on **debian-based** distributions using neofetch.
2023-04-03 16:34:58 +00:00
2023-04-03 16:53:42 +00:00
Requirements
------------
2023-04-03 16:34:58 +00:00
2023-04-03 16:53:42 +00:00
None.
2023-04-03 16:34:58 +00:00
2023-04-03 16:53:42 +00:00
Role Variables
--------------
2023-04-03 21:24:24 +00:00
Available variables are listed below, along with default values. A sample file for the default values is available in `default/update_motd.yml.sample` in case you need it for any `group_vars` or `host_vars` configuration.
2023-04-03 16:34:58 +00:00
2023-04-03 16:53:42 +00:00
```yaml
2023-04-03 21:24:24 +00:00
update_motd_filename: "00-motd-neofetch"
2023-04-03 16:53:42 +00:00
```
2023-04-03 21:24:24 +00:00
This variable sets the name for the file that'll be created in `/etc/update-motd.d` on the target system.
2023-04-03 16:34:58 +00:00
2023-04-03 16:53:42 +00:00
```yaml
2023-04-03 21:24:24 +00:00
update_motd_print_info:
- name: "CPU"
module: "cpu"
2023-04-03 16:53:42 +00:00
```
2023-04-03 21:24:24 +00:00
This variable is the list of modules that you want to enable in your motd. It references the neofetch modules. The `name` is the title that'll be appended to each module.
2023-04-03 16:34:58 +00:00
2023-04-03 21:24:24 +00:00
All of the other variables are used for the configuration file of neofetch that'll sit in `/etc/profile.d/motd/cfg` by default.
These are one to one identical to the neofetch modules. Documentation on the different settings can be found in the `files/documentation` file. It's just a copy on the default neofetch config file.
2023-04-03 16:34:58 +00:00
2023-04-03 16:53:42 +00:00
Dependencies
------------
2023-04-03 16:34:58 +00:00
2023-04-07 22:45:34 +00:00
This role has a task that installs its own dependencies located in `task/prerequisites.yml`, so that you don't need to manage them. This role requires `ednxzu.manage_apt_packages` in order to make sure that neofetch is installed.
2023-04-03 16:34:58 +00:00
2023-04-03 16:53:42 +00:00
Example Playbook
----------------
2023-04-03 16:34:58 +00:00
2023-04-03 16:53:42 +00:00
```yaml
# calling the role inside a playbook with either the default or group_vars/host_vars
- hosts: servers
roles:
2023-04-03 21:24:24 +00:00
- ednxzu.update_motd
2023-04-03 16:53:42 +00:00
```
2023-04-03 16:34:58 +00:00
2023-04-03 16:53:42 +00:00
License
-------
2023-04-03 16:34:58 +00:00
2023-04-03 16:53:42 +00:00
MIT / BSD
2023-04-03 16:34:58 +00:00
2023-04-03 16:53:42 +00:00
Author Information
------------------
2023-04-03 16:34:58 +00:00
2023-07-19 21:11:53 +00:00
This role was created by Bertrand Lanson in 2023.