Skip to main content

dumb web interface to search/browse indexed text files

Project description

dumb web search

  • index a directory of text files in sqlite database
  • web browse this directory
  • web search this directory with indexed text

how to run

locally

./index.py --docroot /path/to/markdown/dir --database /path/to/database.sqlite index

HTTP_SERVER_BASEURL=/reverse/proxy/subpath HTTP_SERVER_PORT=1234 INDEX_DIR=/path/to/markdown/dir INDEX_DATABASE=/path/to/database.sqlite ./browse.wsgi

in a docker/podman container:

docker run -d -v /path/to/your/markdown/files:/text -v dumbwebsearch-db:/database -e HTTP_SERVER_BASEURL=/reverse/proxy/subpath -p 8000:8000 registry.gitlab.com/hydrargyrum/dumbwebsearch:latest

requirements

  • python3
  • sqlite to index/search text
  • wsgi to expose said app
  • jinja2 + bottle as web framework
  • pandoc

security

  • no authentication: put a reverse proxy in front of it with some login
  • no optimization for performance: put a reverse proxy to prevent hammering
  • pandoc is run to render markdown files, which may have its own problems

what could be better done

  • don't make markdown so much ingrained in this app

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

dumbwebsearch-0.2.0.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

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

dumbwebsearch-0.2.0-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file dumbwebsearch-0.2.0.tar.gz.

File metadata

  • Download URL: dumbwebsearch-0.2.0.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for dumbwebsearch-0.2.0.tar.gz
Algorithm Hash digest
SHA256 4f46b93a4a6186d485f3c3655a58983f7fb38c90195d67695aae8aa42c6c4a67
MD5 aa51b015fedff26953f0ce91d3188da7
BLAKE2b-256 2c847229b5de184dac4b162a2c55d4f3817ab066bc5d2a635d083088c8ca7013

See more details on using hashes here.

File details

Details for the file dumbwebsearch-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: dumbwebsearch-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for dumbwebsearch-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9ac5fd63b5a374d3effe56a957c9534aaa39493e85fdb3f7947d93e893ae9aa0
MD5 a32459850d421c48d0e243146ba21527
BLAKE2b-256 669e141c3829299e8ac29d834dba4586247b3f581b8676efb78b02c48a521f09

See more details on using hashes here.

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