1# Referrers for DokuWiki
2
3## License
4
5* **Author**: [Terence J. Grant](mailto:tjgrant@tatewake.com)
6* **License**: [GNU GPL v2](http://opensource.org/licenses/GPL-2.0)
7* **Latest Release**: v1.0.0 on Sep 19th, 2020
8* **Changes**: See [CHANGELOG.md](CHANGELOG.md) for full details.
9* **Donate**: [Donations](http://tjgrant.com/wiki/donate) and [Sponsorships](https://github.com/sponsors/tatewake) are appreciated!
10
11## About
12
13This plugin logs [HTTP Referrers](https://en.wikipedia.org/wiki/HTTP_referer) for your site, so you can see where your traffic comes from.
14
15Set the options for this plugin via the **Configuration Settings** menu from the DokuWiki admin menu. (It will be near the bottom of the page.)
16
17## Install / Upgrade
18
19Search and install the plugin using the [Extension Manager](https://www.dokuwiki.org/plugin:extension). Refer to [Plugins](https://www.dokuwiki.org/plugins) on how to install plugins manually.
20
21## Setup
22
23The log will be located at the page `:wiki:referrers`, so you will need to create that page for this plugin to work.
24
25It is also recommended that you use DokuWiki's **Access Control List Management** feature (available from the **Admin** page) to make `:wiki:referrers` not publicly readable so search engines won't index it.
26
27
28All further documentation for this plugin can be found at:
29
30 * [https://www.dokuwiki.org/plugin:referrers](https://www.dokuwiki.org/plugin:referrers)
31
32## Contributing
33
34The official repository for this plugin is available on GitHub:
35
36* [https://github.com/tatewake/dokuwiki-plugin-referrers](https://github.com/tatewake/dokuwiki-plugin-referrers)
37
38The plugin thrives from community contributions. If you're able to provide useful code changes or bug fixes, they will likely be accepted to future versions of the plugin.
39
40If you find my work helpful and would like to give back, [consider joining me as a GitHub sponsor](https://github.com/sponsors/tatewake).
41
42Thanks!
43
44--Terence
45