Skip to main content

REDbot is lint for HTTP.

Project description

REDbot

REDbot is lint for HTTP resources.

It checks HTTP resources for feature support and common protocol problems at the HTTP semantic and caching layers. You can use the public instance on https://redbot.org/, or you can install it locally.

Test

Contributing to REDbot

Your ideas, questions and other contributions are most welcome. See CONTRIBUTING.md for details.

Setting Up Your Own REDbot

Installation

REDbot requires a current version of Python.

The recommended method for installing REDbot is using pipx. To install the latest release, do:

pipx install redbot

Or, to use the most development version of REDbot, run:

pipx install git+https://github.com/mnot/redbot.git

Both of these methods will install the following programs into your pipx binary folder:

  • redbot - the command-line interface
  • redbot_daemon - Web interface as a standalone daemon

Running REDbot as a systemd Service

REDbot can run as a standalone service, managed by systemd. This offers a degree of sandboxing and resource management, as well as process monitoring (including a watchdog function).

To do this, install REDbot on your system with the systemd option. For example:

pipx install redbot[systemd]

The copy extra/redbot.service into the appropriate directory (on most systems, /etc/systemd/system/.)

Modify the file appropriately; this is only a sample. Then, as root:

> systemctl reload-daemon
> systemctl enable redbot
> systemctl start redbot

By default, REDbot will listen on localhost port 8000. This can be adjusted in config.txt. Running REDbot behind a reverse proxy is recommended, if it is to be exposed to the Internet.

If you want to allow people to save test results, create the directory referenced by the 'save_dir' configuration variable, and make sure that it's writable to the REDbot process.

Running REDbot in a Container

OCI-compliant containers are available on Github, and it's easy to run REDbot one using a tool like Docker or Podman. For example:

docker run --rm -p 8000:8000 ghcr.io/mnot/redbot

or

podman run --rm -p 8000:8000 ghcr.io/mnot/redbot

Credits

Icons by Font Awesome. REDbot includes code from tippy.js and prettify.js.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

redbot-2.3.6.tar.gz (341.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

redbot-2.3.6-py3-none-any.whl (378.8 kB view details)

Uploaded Python 3

File details

Details for the file redbot-2.3.6.tar.gz.

File metadata

  • Download URL: redbot-2.3.6.tar.gz
  • Upload date:
  • Size: 341.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for redbot-2.3.6.tar.gz
Algorithm Hash digest
SHA256 622e1c4564180aa2786cff4c0bdc9b74d664e5cfad5cd0bd3dedd893e12b3841
MD5 aa76cf0fbe5ead8826ff01537098581a
BLAKE2b-256 94eb8117d928efe0af0f9a15f9f82d971daecc44e8870a4dcedd0914cf199cac

See more details on using hashes here.

Provenance

The following attestation bundles were made for redbot-2.3.6.tar.gz:

Publisher: publish.yml on mnot/redbot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file redbot-2.3.6-py3-none-any.whl.

File metadata

  • Download URL: redbot-2.3.6-py3-none-any.whl
  • Upload date:
  • Size: 378.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for redbot-2.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 37f55dc3351c2f3435831fdf5bd41dbc383157d2e43c1e7295b63d99b3b8a4d6
MD5 d663ddabba773c2c3d873ffe8eca847d
BLAKE2b-256 a05a8819237d36a457db9b648d821abaedd5edcec142ee93a334e16e11b246aa

See more details on using hashes here.

Provenance

The following attestation bundles were made for redbot-2.3.6-py3-none-any.whl:

Publisher: publish.yml on mnot/redbot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page