Skip to content

Commit

Permalink
doc update since conf directory is no longer there
Browse files Browse the repository at this point in the history
  • Loading branch information
edsu committed Jul 30, 2014
1 parent 886572e commit 012c904
Showing 1 changed file with 5 additions and 18 deletions.
23 changes: 5 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,24 +41,12 @@ or with an array of start/end IP addresses:
These two are equivalent, but the former is a bit faster, and easier to read.
The latter is convenient if your range is difficult to express using a netmask.

### Transparency

If you end up running an anon bot we would love to document the IP address
ranges you use for transparency purposes. Please add just the ranges
stanza of your onfig file to the `conf` directory. Name the file using your
Twitter account, e.g. for congressedits:

conf/congressedits.json

You can use a service like [ARIN Online](http://whois.arin.net/ui) to look up
IP address ranges by organization name.

If you would like your configuration file to reference the IP addresses in
the external file just use the filename. So instead of:

```javascript
{
"nick": "congressedits",
"nick": "anon1234",
"accounts": [
{
"consumer_key": "",
Expand All @@ -67,9 +55,8 @@ the external file just use the filename. So instead of:
"access_token_secret": "",
"template": "{{page}} Wikipedia article edited anonymously from {{name}} {{&url}}",
"ranges": {
"US House of Representatives": [
["143.231.0.0", "143.231.255.255"],
["74.119.128.0", "74.119.131.255"]
"Home Network": [
["192.168.1.1", "192.168.255.255"]
]
}
}
Expand All @@ -81,15 +68,15 @@ you would have:

```javascript
{
"nick": "congressedits",
"nick": "anon1234",
"accounts": [
{
"consumer_key": "",
"consumer_secret": "",
"access_token": "",
"access_token_secret": "",
"template": "{{page}} Wikipedia article edited anonymously from {{name}} {{&url}}",
"ranges": "conf/congressedits.json"
"ranges": "ranges.json"
}
]
}
Expand Down

0 comments on commit 012c904

Please sign in to comment.