Skip to content

Commit 17c1757

Browse files
committed
Added build badges
Allows everyone to see the status of the builds
1 parent 8e56fb3 commit 17c1757

File tree

1 file changed

+33
-31
lines changed

1 file changed

+33
-31
lines changed

README.md

+33-31
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# 404 Handler for EPiServer
2+
**Build status:** [![Build status](https://ci.appveyor.com/api/projects/status/9v7mx552smrq6m8x?svg=true&passingText=CMS%209%20OK&failingText=CMS%209%20Failed)](https://ci.appveyor.com/project/evest/404handler) [![Build status](https://ci.appveyor.com/api/projects/status/lypciaqvdchet4xp?svg=true&passingText=CMS%208%20OK&failingText=CMS%208%20Failed)](https://ci.appveyor.com/project/evest/404handler-30u3b)
3+
24
The popular 404 handler for EPiServer, enabling better control over your 404 page in addition to allowing redirects for old urls that no longer works.
35

46
The perfect companion if you're transitioning to EPiServer from another system and cannot keep the url structure, or plan to do major re-structuring of your content.
@@ -41,37 +43,37 @@ The `httpErrors` section is responsible for showing a custom 404 page. If you do
4143

4244
**Important!** `errorMode` needs to be set to `Custom` and `existingResponse` needs to be set to `Replace`, or the 404 page will not be shown, or will only be shown for urls not ending with `.aspx`.
4345

44-
## Logging
45-
Suggestions for 404 rules require 404 requests to be logged to the database.
46-
47-
Logging of 404 requests is buffered to shield your application from Denial of Service attacks. By default, logging will happen for every 30'th error. You can edit the `bvn404Handler` section in `web.config` and set `bufferSize="0"` to log the errors immediately. This is not recommended as you will be vulnerable to massive logging to your database. You can control how much you would like to log by specifying a threshold value. This value determines how frequent 404 errors are allowed to be logged.
48-
49-
**Important!** Even if the threshold is set low, you can still receive a lot of requests in the 404 log. In the Admin view (follow "Administer" link in gadget) you can delete suggestions (logged 404 requests). You can find all the logged items in the `BVN.NotFoundRequests` table in your CMS database if you want to manually clear the logged requests (this will not remove any redirects).
50-
51-
![](https://raw.githubusercontent.com/BVNetwork/404handler/master/doc/img/Administer.png)
52-
53-
```xml
54-
<bvn404Handler handlerMode="On" logging="On" bufferSize="30" threshold="5">
55-
</bvn404Handler>
56-
```
57-
58-
**logging**: Turn logging `On` or `Off`. Default is `On`
59-
60-
**bufferSize**: Size of memory buffer to hold 404 requests. Default is 30
61-
62-
**threshold**: Average maximum allowed requests per second. Default is 5
63-
64-
* Example 1:
65-
* bufferSize is set to 100, threshold is set to 10
66-
* Case: 100 errors in 5 seconds - (diff = seconds between first logged request and the last logged request in the buffer).
67-
* 100 / 5 = 20. Error frequency is higher than threshold value. Buffered requests will not get logged, the entire buffer will be discarded.
68-
* Example 2:
69-
* bufferSize is 100, threshold is 10
70-
* Case: 100 errors in 15 seconds
71-
* 100 / 15 = 6. Error frequency is within threshold value. Buffered requests will get logged.
72-
73-
If the `bufferSize` is set to 0, the `threshold` value will be ignored, and every request will be logged immediately.
74-
46+
## Logging
47+
Suggestions for 404 rules require 404 requests to be logged to the database.
48+
49+
Logging of 404 requests is buffered to shield your application from Denial of Service attacks. By default, logging will happen for every 30'th error. You can edit the `bvn404Handler` section in `web.config` and set `bufferSize="0"` to log the errors immediately. This is not recommended as you will be vulnerable to massive logging to your database. You can control how much you would like to log by specifying a threshold value. This value determines how frequent 404 errors are allowed to be logged.
50+
51+
**Important!** Even if the threshold is set low, you can still receive a lot of requests in the 404 log. In the Admin view (follow "Administer" link in gadget) you can delete suggestions (logged 404 requests). You can find all the logged items in the `BVN.NotFoundRequests` table in your CMS database if you want to manually clear the logged requests (this will not remove any redirects).
52+
53+
![](https://raw.githubusercontent.com/BVNetwork/404handler/master/doc/img/Administer.png)
54+
55+
```xml
56+
<bvn404Handler handlerMode="On" logging="On" bufferSize="30" threshold="5">
57+
</bvn404Handler>
58+
```
59+
60+
**logging**: Turn logging `On` or `Off`. Default is `On`
61+
62+
**bufferSize**: Size of memory buffer to hold 404 requests. Default is 30
63+
64+
**threshold**: Average maximum allowed requests per second. Default is 5
65+
66+
* Example 1:
67+
* bufferSize is set to 100, threshold is set to 10
68+
* Case: 100 errors in 5 seconds - (diff = seconds between first logged request and the last logged request in the buffer).
69+
* 100 / 5 = 20. Error frequency is higher than threshold value. Buffered requests will not get logged, the entire buffer will be discarded.
70+
* Example 2:
71+
* bufferSize is 100, threshold is 10
72+
* Case: 100 errors in 15 seconds
73+
* 100 / 15 = 6. Error frequency is within threshold value. Buffered requests will get logged.
74+
75+
If the `bufferSize` is set to 0, the `threshold` value will be ignored, and every request will be logged immediately.
76+
7577
## Specifying ignored resources
7678
By default, requests to files with the following extensions will be ignored by the redirect module: `jpg,gif,png,css,js,ico,swf,woff`
7779

0 commit comments

Comments
 (0)