From f1acab741ef5458d6057fb796ef69315f16e2c10 Mon Sep 17 00:00:00 2001 From: Taylor Thurlow Date: Mon, 14 May 2018 11:55:28 -0700 Subject: [PATCH] Move distro config info to Wiki, update README --- README.md | 26 +------------------------- 1 file changed, 1 insertion(+), 25 deletions(-) diff --git a/README.md b/README.md index 0cbf8e9..7ab1e46 100644 --- a/README.md +++ b/README.md @@ -28,31 +28,7 @@ sudo gem install panda-motd At this point, you can run `panda-motd ~/.config/panda-motd.yaml` (without `sudo`) from anywhere, which will generate a configuration file located at `~/.config/panda-motd.yaml`. This file contains a description of each component of the MOTD and how to enable/disable/configure each one. Components are printed in your MOTD in the same order that they are defined in this configuration file. -Actually getting the output of the gem to become your MOTD is going to depend on your Linux distribution. Currently, it is only tested and working on **Ubuntu 16.04 LTS**: -* Go to the `/etc/update-motd.d` folder and inspect its contents. The MOTD is formed by running each of these scripts in numerical order (really alphabetically, but the convention is to start each script with two numbers), as root. The factory MOTD is generated using these scripts. -* If you desire to completely replace all of these scripts with `panda-motd`, it would be wise to make a copy of the `update-motd.d` folder, and then remove all of the factory scripts. -* Create a new file in `update-motd.d` and call it `00-pandamotd`, (or really, whatever you want). Remember, the numbers at the beginning of the filename are what determine the order of execution if you have any other scripts in the folder. In this file, use a text editor to write the contents as follows, **substituting `YOUR_USERNAME` with your username**: - -~~~bash -#!/bin/sh - -echo "" > /var/log/panda-motd.error.log -panda-motd /home/YOUR_USERNAME/.config/panda-motd.yaml 2> /var/log/panda-motd.error.log -if [ -s "/var/log/panda-motd.error.log" ] -then - echo "panda-motd had errors. Check '/var/log/panda-motd.error.log'." -fi -~~~ - -* Make the new file you created executable, by doing: - -~~~bash -sudo chmod +x /etc/update-motd.d/00-pandamotd -~~~ - -* You should now be able to log in to the machine over SSH and see the generated MOTD. If there are any errors, you will be notified. - -**Note:** Instructions for other distributions will become available over time. If you are successful in modifying your MOTD on a distribution which has no instructions yet, please open an issue so we can get the process documented. I will likely be starting a Wiki section for this purpose. +Actually getting the output of the gem to become your MOTD is going to depend on your Linux distribution. Please find your Linux distribution on [this wiki page](https://github.com/taylorthurlow/panda-motd/wiki/Configuring-Linux-to-use-panda-motd-as-the-MOTD) and follow the instructions. ### Contributing Due to the fact that this project is very new, things are changing very rapidly. Things are now in a state where I am semi-comfortable with people submitting pull requests. Please open an issue regarding any changes you wish to make before starting to work on anything. Additionally, I don't have much experience in the open-source world, so please forgive me as I familiarize myself with the contribution process. This is very much a learning process for me at the moment.