https://github.com/studiole/logwatch
Create, install and preview Logwatch themes
https://github.com/studiole/logwatch
Last synced: about 1 year ago
JSON representation
Create, install and preview Logwatch themes
- Host: GitHub
- URL: https://github.com/studiole/logwatch
- Owner: StudioLE
- License: mit
- Created: 2015-07-23T16:05:02.000Z (almost 11 years ago)
- Default Branch: main
- Last Pushed: 2022-03-26T23:12:45.000Z (about 4 years ago)
- Last Synced: 2025-03-15T09:08:05.266Z (over 1 year ago)
- Language: HTML
- Size: 103 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Theme Logwatch
I grew tired of the lack of finese in Logwatch's default HTML template so I put together this little Node.js tool to assist with creating, previewing and installing new themes.
## Features
Theme Logwatch provides two main functions.
1. Install themes to Logwatch
2. Create & preview your own themes
## Installation
The application requires Node.js and npm to be installed, instructions can be found at [nodejs.org](http://nodejs.org/).
With node installed run the following to install Theme Logwatch globally.
```
npm install -g logwatch
```
## Configuration
The application uses [dotenv](https://www.npmjs.com/package/dotenv) for configuration. Simply make a copy of `.env.example` named `.env` and change the settings.
```
cd /usr/lib/node_modules/logwatch
cp .env.example .env
nano .env
```
## Usage
### Install a theme
The install a theme function will copy the header and footer files from the named sub-directory within `./themes` to the Logwatch theme location defined in the config file.
```
theme-logwatch install [THEME_NAME]
```
### Create a theme
Creating a theme will simply copy the default theme files into a new sub-directory of themes for you to edit and then preview.
```
theme-logwatch create [THEME_NAME]
```
### Preview a theme
Preview a theme with sample data in your browser.
```
theme-logwatch preview
```
## References
Here are a few links, I came across during my research, that provide more indepth configuration of Logwatch:
- [Adding additional header information](http://jviz.research.iat.sfu.ca/wiki/index.php?title=Customizing_Logwatch)