Redmine

What is website screenshot:¶

When QA report a bug or support follow up a task, it is very common we need work base on one URL and we need to see the screenshot of it as well. In this case, we need click the link and go to that website. We use Website Screenshot plug-in allow you insert a image for one URL quickly. So, we can save sometime for family or beer.

User guide¶

Following is a simple user guide how to use it:
1. After install it, you will see a small button in the editor;

2. Click this button, you will see a pop up

Please feel in URL of the page you want to convert to image and select a size. Then click insert button.
3. Save the issue.
4. You will see the screenshot in the issue description field. Very cool. :)

Core features:¶

You will get following benefit from this plug-in by default (or not by default):

• Quickly see one website page;
• Refresh page monthly automatically;
• Resize the screenshot images (Redmine does not support image size. But we support.)

Limitations:¶

Everything has limitation. But we do have some more.

• Cannot use on SSL server. (No workaround.)
• Cannot use more than 100 times per day with a free account.
• Cannot take screenshot with a non-public website.

Background technology & documents:¶

If you are interesting how we implement this magic plug-in, there are some information.
We used page2images API to generate the website screenshot.
We used JQuery to implement the tool in front end.
If you want, you can get more information about the API we used:

• Website Screenshot API Document
• Convert HTML to Image API Document

• Download this plug-in into your redmine_root/plugins/ folder
• Get an API Key for your server. We used page2images website screenshot to implement this plug-in. Therefore, we need require an API key on it. Do not worry, it is totally free for most of users.

Click this button after login.

Click this button to require a new key for your server.

For example, you need install this on www.example.com. Then, you need input:

After that, you will get a unique key for www.example.com . Please open file /assets/javascripts/wiki-page2images-key.js and input the key in the source code.