Skip to content

Adding config info to allow urls with ports #112

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

Merged
merged 3 commits into from
Mar 31, 2021
Merged

Adding config info to allow urls with ports #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
73e8503
Adding config info to allow urls with ports
sanders41 Mar 31, 2021
412b03a
Update to js_render instructions
sanders41 Mar 31, 2021
39237c5
Typo fixes
sanders41 Mar 31, 2021
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ src/strategies/__pycache__/
*.pyc
.env
update.sh
.python-version

*yarn.lock

Expand Down
38 changes: 38 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ This scraper is used in production and runs on the [MeiliSearch documentation](h
- [`custom_settings` (optional)](#custom_settings-optional)
- [`min_indexed_level` (optional)](#min_indexed_level-optional)
- [`only_content_level` (optional)](#only_content_level-optional)
- [`js_render` (optional)](#js_render-optional)
- [`js_wait` (optional)](#js_wait-optional)
- [`allowed_domains` (optional)](#allowed_domains-optional)
- [Authentication](#authentication)
- [Installing Chrome Headless](#installing-chrome-headless)
- [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
Expand Down Expand Up @@ -459,6 +462,41 @@ If used, `min_indexed_level` is ignored.
}
```

#### `js_render` (optional)

When `js_render` is set to `true`, the scraper will use ChromeDriver. This is needed for pages that are rendered with JavaScript, for example, pages generated with React, Vue, or applications that are running in development mode: `autoreload` `watch`.

After installing ChromeDriver, provide the path to the bin using the following environment variable `CHROMEDRIVER_PATH` (default value is `/usr/bin/chromedriver`).

The default value of `js_render` is `false`.

```json
{
"js_render": true
}
```

#### `js_wait` (optional)

This setting can be used when `js_render` is set to `true` and the pages need time to fully load. `js_wait` takes an integer is specifies the number of seconds the scraper should wait for the page to load.

```json
{
"js_render": true,
"js_wait": 1
}
```

#### `allowed_domains` (optional)

This setting specifies the domains that the scraper is allowed to access. In most cases the `allowed_domains` will be automatically set using the `start_urls` and `stop_urls`. When scraping a domain that contains a port, for example `http://localhost:8080`, the domain needs to be manually added to the configuration.

```json
{
"allowed_domains": ["localhost"]
}
```

### Authentication

__WARNING:__ Please be aware that the scraper will send authentication headers to every scraped site, so use `allowed_domains` to adjust the scope accordingly!
Expand Down