owdex Download - owdex Source code download

owdex

Other source code

v2.1.0

Download

owdex

an open web index

Owdex is an open index of pages from across the web. Instead of crawling through hypertext based on links, it only indexes pages that its users direct it to. Owdex aims to build a better alternative to web search by cutting through the cruft of junk results and bringing focus to real information.

Installation and usage

In production

With Docker Compose (recommended)

We recommend using Docker Compose in production. An example setup is available at owdex/compose.

$ git clone https://github.com/owdex/compose.git owdex && cd owdex
$ chmod +x setup.sh
$ ./setup.sh
$ nano owdex.toml
# Edit the configuration file, being sure to change the secret key and admin password.
$ nano misc/Caddyfile
# Edit the reverse proxy configuration, being sure to change the domain name and email.
$ docker compose up -d

With Docker

If you already have Solr and MongoDB instances running elsewhere, you can just use Owdex on its own. Images are available for every release from the GitHub Container Registry. Make sure to set the version you want (instead of just pulling 'latest'), as breaking changes may happen at any time.

$ wget https://raw.githubusercontent.com/owdex/compose/main/owdex.toml.default -O owdex.toml
$ nano owdex.toml
# Edit the configuration file, being sure to change the secret key, admin password and database hostnames.
$ docker run --detach --volume ./owdex.toml:/owdex.toml:ro  ghcr.io/owdex/owdex:main

In development

You'll still likely want to use Docker Compose, as it makes managing the databases, as well as building Tailwind CSS, no longer your problem.

$ git clone https://github.com/owdex/owdex.git
$ chmod +x setup.sh
$ ./setup.sh
$ docker compose up --build -d

While you can make changes to owdex.toml, you don't necessarily have to change the admin password or secret key, as these don't matter much in a non-exposed development environment. You can then access the frontend at http://127.0.0.1.