| 1 | <p align="center">
|
| 2 | ﷽
|
| 3 | </p>
|
| 4 |
|
| 5 | # Overview
|
| 6 | Resitail is a tool that streams your [residue](https://github.com/muflihun/residue) logs using hooks.
|
| 7 |
|
| 8 | Samples directory contain fully functional [slack](https://slack.com/) webhook.
|
| 9 |
|
| 10 | [](https://www.npmjs.com/package/resitail)
|
| 11 | [](https://github.com/muflihun/resitail/blob/master/LICENSE)
|
| 12 | [](https://www.paypal.me/MuflihunDotCom/25)
|
| 13 |
|
| 14 | ## Quick start
|
| 15 |
|
| 16 | - `npm install -g resitail`
|
| 17 | - `sudo resitail --config <config>`
|
| 18 |
|
| 19 | Notice the `sudo`, this is because all the files written by residue server will need sudo access as they may be owned by one user or another with limited permissions. Resitail needs to be able to read all of these log files.
|
| 20 |
|
| 21 | ## License
|
| 22 | ```
|
| 23 | Copyright 2017-present Muflihun Labs
|
| 24 | Copyright 2017-present @abumusamq
|
| 25 |
|
| 26 | https://github.com/muflihun/
|
| 27 | https://muflihun.com/
|
| 28 | https://muflihun.github.io/
|
| 29 |
|
| 30 | Licensed under the Apache License, Version 2.0 (the "License");
|
| 31 | you may not use this file except in compliance with the License.
|
| 32 | You may obtain a copy of the License at
|
| 33 |
|
| 34 | http://www.apache.org/licenses/LICENSE-2.0
|
| 35 |
|
| 36 | Unless required by applicable law or agreed to in writing, software
|
| 37 | distributed under the License is distributed on an "AS IS" BASIS,
|
| 38 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
| 39 | See the License for the specific language governing permissions and
|
| 40 | limitations under the License.
|
| 41 | ```
|