Skip to content

Commit fbd1913

Browse files
committed
document where to find the default whitelist, fixes schweikert#75
1 parent 6f60ea6 commit fbd1913

File tree

2 files changed

+26
-5
lines changed

2 files changed

+26
-5
lines changed

README.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@
88
- Homepage = http://postgrey.schweikert.ch/
99
- Project + Issues = https://github.com/schweikert/postgrey
1010

11-
## Requirements
11+
## Installation
12+
13+
It is recommended that you use Postgrey from your Linux distribution, if
14+
possible. Otherwise, you will need to install first the following requirements:
1215

1316
- Perl >= 5.6.0
1417
- Net::Server (Perl Module)
@@ -18,16 +21,24 @@
1821
- Digest::SHA (Perl Module, only for --privacy option)
1922
- NetAddr::IP
2023

24+
## Documentation
2125

22-
## Dev Documentation
23-
24-
To see POD documentation in postgrey. Execute:
26+
To see the documentation in postgrey. Execute:
2527
```bash
2628
perldoc postgrey
2729
```
2830

29-
31+
(or `man postgrey` if you are using a pre-built Postgrey distribution).
32+
33+
## Updating the whitelist
34+
35+
You can find at the following URL the latest whitelist that is included
36+
in the Postgrey distribution:
37+
38+
<https://postgrey.schweikert.ch/pub/postgrey_whitelist_clients>
3039

40+
If you fetch this list automatically, please make sure that you don't do it too
41+
frequently (updating once a day is ok).
3142

3243
## Mailing-List and getting Help
3344

postgrey

+10
Original file line numberDiff line numberDiff line change
@@ -957,6 +957,16 @@ anything that matches C<regexp> (the full address is matched).
957957
958958
=back
959959
960+
=head2 Updating the postgrey default whitelist
961+
962+
You can find at the following URL the latest whitelist that is included
963+
in the Postgrey distribution:
964+
965+
L<https://postgrey.schweikert.ch/pub/postgrey_whitelist_clients>
966+
967+
If you fetch this list automatically, please make sure that you don't do it too
968+
frequently (updating once a day is ok).
969+
960970
=head2 Auto-whitelisting clients
961971
962972
With the option --auto-whitelist-clients a client IP address will be

0 commit comments

Comments
 (0)