https://github.com/rtlee9/404-sentry-link-scanner
API for scanning sites for broken links through automatic, recurring jobs
https://github.com/rtlee9/404-sentry-link-scanner
Last synced: over 1 year ago
JSON representation
API for scanning sites for broken links through automatic, recurring jobs
- Host: GitHub
- URL: https://github.com/rtlee9/404-sentry-link-scanner
- Owner: rtlee9
- License: gpl-3.0
- Created: 2018-01-17T04:24:43.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-04-12T01:13:04.000Z (about 4 years ago)
- Last Synced: 2025-01-04T06:43:28.229Z (over 1 year ago)
- Language: Python
- Size: 180 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 404 Sentry
## Link scanner API
1 out of 20 html links will break within the first year. Broken links on your website can ruin the user experience and turn users away, ultimately lowering future web traffic and related revenues. Links can break through no fault of your own and you'd never even notice. [404 Sentry](https://404sentry.com/) protects your site by scanning it for broken links (404s plus other exceptions) through automatic, recurring jobs and sends a summary of any potential errors directly to your inbox.
Use this API to self host your 404 Sentry scanner or sign up for automated, recurring scan jobs on the [404 Sentry web app](https://404sentry.com/) to make sure your content is never out of date!
## Local usage (Python 3.6)
1. Set environment variables:
* `DATABASE_URL`: URL of PostgreSQL server
* `CONFIG`: configuration type (ProductionConfig, StagingConfig, DevelopmentConfig, TestingConfig)
* `EMAIL_ADDRESS`: email address from which to send alerts
* `EMAIL_PASSWORD`: email password for sending alerts
* `TEST_USER`: username for test authentication
* `TEST_PASSWORD`: password for test authentication
1. Initialize Postgres db (one time): `python create_exception_descriptions.py`
1. Set up virtualenv: `virtualenv venv && source venv/bin/activate`
1. Install requirements: `pip install -r requirements.txt`
1. Run web application: `python run.py` or `gunicorn app:app`