2018-10-11 08:11:21 +00:00
|
|
|
# Webgalen
|
2018-09-20 23:25:39 +00:00
|
|
|
|
2018-10-11 08:11:55 +00:00
|
|
|
A tool to dissect of websites (tribute to [Galen of Pergamon](https://en.wikipedia.org/wiki/Galen))
|
2018-09-20 23:25:39 +00:00
|
|
|
|
2018-10-11 08:27:48 +00:00
|
|
|
It is able to :
|
|
|
|
|
- crawl websites to create a sitemap,
|
2018-10-11 08:33:00 +00:00
|
|
|
- uses the sitemap to create website screenshots (full page length)
|
2018-10-11 08:27:48 +00:00
|
|
|
|
2018-10-11 08:28:09 +00:00
|
|
|
## Roadmap (:warning: work in progress/unstable)
|
2018-10-11 08:27:48 +00:00
|
|
|
|
2018-10-11 08:28:09 +00:00
|
|
|
- device profiles selection for screenshots
|
2018-10-11 08:27:48 +00:00
|
|
|
- compare screenshots to produce a diff (i already have a fully fonctional side-project for that, waiting to be integrated and automated in webgalen)
|
|
|
|
|
- annotate screenshots (define a bounding-box => add comment + red/green figures like the ones on trello => produce screenshot slices)
|
|
|
|
|
- push annotation + slices on a project management tool (ex: trello, redmine, etc.)
|
|
|
|
|
- use annotation bounding-box + diff to detect which comments are involved in a diff (modifié)
|
|
|
|
|
|
2018-10-11 08:11:21 +00:00
|
|
|
## Prerequisites
|
2018-09-20 23:25:39 +00:00
|
|
|
|
2018-10-11 08:11:21 +00:00
|
|
|
Install a few tools
|
2018-09-20 23:25:39 +00:00
|
|
|
|
2018-10-11 08:11:21 +00:00
|
|
|
apt-get install img2pdf imagemagick
|
2018-09-20 23:25:39 +00:00
|
|
|
|
2018-10-11 08:11:21 +00:00
|
|
|
Increase memory in imagemagick policy `/etc/ImageMagick-6/policy.xml`
|
2018-09-20 23:25:39 +00:00
|
|
|
|
2018-10-11 08:11:21 +00:00
|
|
|
<policy domain="resource" name="memory" value="2GiB"/>
|
2018-09-20 23:25:39 +00:00
|
|
|
|
2018-10-11 08:15:01 +00:00
|
|
|
## Usage
|
|
|
|
|
|
2018-10-11 08:15:53 +00:00
|
|
|
$ be exe/webgalen
|
|
|
|
|
Commands:
|
|
|
|
|
webgalen help [COMMAND] # Describe available commands or one specific command
|
|
|
|
|
webgalen list-devices # list available profiles
|
|
|
|
|
webgalen screenshot FILE # take screenshots for each page
|
|
|
|
|
webgalen sitemap URL FILE # crawl site and export sitemap
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
-ua, [--user-agent=USER-AGENT] # choose user agent (default Mozilla)
|
2018-10-11 08:15:01 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
1. Fork it ( http://github.com/glenux/webgalen/fork )
|
|
|
|
|
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
|
|
|
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
|
|
|
4. Push to the branch (`git push origin my-new-feature`)
|
|
|
|
|
5. Create new Pull Request
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Credits
|
|
|
|
|
|
|
|
|
|
Author & Maintainer: Glenn Y. ROLLAND
|
|
|
|
|
|
|
|
|
|
Contributors: none yet ;)
|
|
|
|
|
|
|
|
|
|
Got questions? Need help? Tweet at @glenux
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
Webgalen is Copyright © 2018 Glenn ROLLAND. It is free software, and may be redistributed under the terms specified in the LICENSE file.
|
|
|
|
|
|
