- Rust 86.4%
- CSS 8.2%
- Jinja 4.5%
- Dockerfile 0.5%
- Shell 0.4%
wikiviewer
An alternative frontend for Wikipedia.
About
wikiviewer aims to provide a simpler, less-disturbing way to browse Wikipedia articles. It takes its inspiration from other alternative frontends such as SearXNG, RedLib and libremdb.
Built with
- https://github.com/Bnyro/wikitext-parser - Parsing and rendering the Wikitext articles provided by Wikipedia.
- https://github.com/Bnyro/latex2mathml - Parsing LaTeX math formulas and converting them to HTML.
Kindly open an issue upstream at these repositories if you run into problems with the described functionalities.
Installation
Docker Compose
If you don't have docker-compose installed yet, please follow the instructions at https://docs.docker.com/compose/install.
Copy docker-compose.yml and modify the relevant settings (see Configuration).
Start wikiviewer in detached mode (running in the background):
docker compose up -d
View the logs of the wikiviewer container:
docker compose logs -f
Manual Installation
wikiviewer can be configured via the following environment variables:
Clone the repository:
git clone https://codeberg.org/bnyro/wikiviewer.git
Build the app via cargo:
cargo build --release
Now you can run the app by executing
./target/release/wikiviewer
Configuration
| Variable name | Description | Default value |
|---|---|---|
| WIKIVIEWER_HOST | The url to run the app to. | 0.0.0.0:3000 |
| WIKIVIEWER_LANGUAGE | The two-letter code of the Wikipedia instance to use. | en (i.e. this uses https://en.wikipedia.org) |
| WIKIVIEWER_PROXY_ENABLED | Whether to proxy all images through Wikiviewer. | true |
If you run the app via docker, you can directly set them in your docker-compose.yml.
License
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
For more details, see LICENSE.