logman/README.md

44 lines
1.8 KiB
Markdown
Raw Normal View History

2019-09-27 23:51:50 -05:00
# logman
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fwymillerlinux%2Flogman.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fwymillerlinux%2Flogman?ref=badge_shield)
2019-09-27 23:51:50 -05:00
Collecting log files for the greater good!
2019-09-29 18:29:13 -05:00
This program lets you grab log files remotely and store them up into a compressed file on your local machine!
In all reality, you can literally grab any file you wish to grab of any remote machine.
2019-09-27 23:51:50 -05:00
## Installation
If you have Go installed, use `go get` for grabbing this repo:
`go get github.com/wymillerlinux/logman`
If you don't have Go installed, I will provide binaries soon.
## Running
Before you start the program, I would like to highlight the attraction to said program.
The configuration file, `config.yaml`, is where you set everything about where you want
to grab logs from.
2019-09-29 18:29:13 -05:00
To run the `logman` program:
`go run .` in the root directory of the project.
To build the `logman` program:
`go build .` and then a binary will appear in the `bin` directory of your `$GOPATH`.
2019-09-27 23:51:50 -05:00
After that, just run the binary and you should be golden.
## Troubleshooting
2019-09-29 18:29:13 -05:00
The GitHub issue board is where I post issues with the program. If you any issue with the program, please post it there. Go panics are a great example of an issue you can post.
2019-09-27 23:51:50 -05:00
I'm new to Go, so forgive the long wait time for any bux fix.
## Contributing
2019-09-29 18:29:13 -05:00
If you would like to contribute, feel free to email me or send in pull requests. `todo.md` should have some things to get you rolling. There's quite a few items on there that I want added to make `logman` a finished product.
## License
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fwymillerlinux%2Flogman.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fwymillerlinux%2Flogman?ref=badge_large)