browsertrix/docs/user-guide/getting-started.md
sua yoo 612bbb6f42
feat: Merge workflow job types (#2068)
Resolves https://github.com/webrecorder/browsertrix/issues/2073

### Changes

- Removes "URL List" and "Seeded Crawl" job type distinction and adds as
additional crawl scope types instead.
- 'New Workflow' button defaults to Single Page
- 'New Workflow' dropdown includes Page Crawl (Single Page, Page List, In-Page Links) and Site Crawl (Page in Same Directory, Page on Same Domain, + Subdomains and Custom Page Prefix)
- Enables specifying `DOCS_URL` in `.env`
- Additional follow-ups in #2090, #2091
2024-09-25 10:37:18 -04:00

1.9 KiB
Raw Blame History

Your First Crawl

Lets crawl your first webpage! Start by opening up a webpage that you'd like to crawl, and note the URL for later.

Logging in

To start crawling with hosted Browsertrix, you'll need a Browsertrix account. Sign up for an account and log in.

!!! note "Self-hosting"

If you'd like to try Browsertrix before signing up, or you have specialized hosting requirements, you can host Browsertrix yourself. [Set up Browsertrix](../deploy/index.md) on your system and log in as your admin user.

Starting the crawl

Once you've logged in you should see your org overview. If you land somewhere else, navigate to Overview.

  1. Tap the Create New... shortcut and select Crawl Workflow.
  2. Choose Page List. We'll get into the details of the options later, but this is a good starting point for a simple crawl.
  3. Enter the URL of the webpage that you noted earlier in Page URL(s).
  4. Tap Review & Save.
  5. Tap Save Workflow.
  6. You should now see your new crawl workflow. Give the crawler a few moments to warm up, and then watch as it archives the webpage!

Next steps

After running your first crawl, check out the following to learn more about Browsertrix's features: