Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adds documentation for custom_suffixes configuration parameter #29

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Adds documentation for custom_suffixes configuration parameter #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ in your `config.exs` as follows:
- `:fallback_local_copy`: The path to the local suffix file that `Domainatrex` will use if it
wasn't able to fetch a fresh file from the URL, or if fetching updated files was disabled;
default is the `"lib/public_suffix_list.dat"` file included in the package.
- `:custom_suffixes`: In the case that a valid suffix is not found in the public suffix file (example: "com.be") it can be added in addition to all of the suffixes found in the public suffix file. default is : `[]`

Here's a complete example of how you might customize this behavior in your `config.exs`:

Expand All @@ -55,5 +56,7 @@ config :domainatrex,
fetch_latest: true,
# Download the public suffix list from the official source (not necessarily tested with Domainatrex!)
public_suffix_list_url: 'https://publicsuffix.org/list/public_suffix_list.dat',
fallback_local_copy: "priv/my_app_custom_suffix_list.dat"
fallback_local_copy: "priv/my_app_custom_suffix_list.dat",
# Add custom suffix for com.be
custom_suffixes: ["com.be"]
```