tlan16/wikimore repository overview
Wikimore - A simple frontend for Wikimedia projects
Wikimore is a simple frontend for Wikimedia projects. It uses the MediaWiki API to fetch data from Wikimedia projects and display it in a user-friendly way. It is built using Flask.
This project is still in development and more features will be added in the future. It is useful for anyone who wants to access Wikimedia projects with a more basic frontend, or to provide access to Wikimedia projects to users who cannot access them directly, for example due to state censorship.
Features
- Supports all Wikimedia projects in all languages
- Search functionality
- Proxy support for Wikimedia images
Instances
| URL | Provided by | Country | Notes |
|---|---|---|---|
| wikimore.private.coffee | Private.coffee | Austria 🇦🇹 🇪🇺 | Main instance |
| wm.bloat.cat | Bloat.cat | Germany 🇩🇪 🇪🇺 | |
| wp.dc09.ru | dc09.ru | Russian Federation 🇷🇺 | |
| wikimore.privadency.com | privadency | Germany 🇩🇪 🇪🇺 | |
| wikimore.blitzw.in | Blitzw.in | Denmark 🇩🇰 🇪🇺 | Runs on modified code |
Tor Hidden Services
| URL | Provided by | Country | Notes |
|---|---|---|---|
| wikimore.coffee2m3bjsrrqqycx6ghkxrnejl2q6nl7pjw2j4clchjj6uk5zozad.onion | Private.coffee | Austria 🇦🇹 🇪🇺 |
Adding Your Instance
To add your own instance to this list, please modify instances.json, run ilgen to update README.md, and open a pull request, or just open an issue letting us know about your instance, see below.
Opening Issues
If you're having problems using Wikimore, or if you have ideas or feedback for us, feel free to open an issue in the Private.coffee Git or on Github.
Of course, you can also join our Matrix room to discuss your ideas with us.
Installation
Production
- Create a virtual environment and activate it
python3 -m venv venv
source venv/bin/activate
- Install the package from PyPI
pip install wikimore
- Run the application
wikimore
- Open your browser and navigate to
http://localhost:8109
Docker
Notice: The current Docker image is now only hosted on the Private.coffee Git. Please update your Docker Compose file to use git.private.coffee/privatecoffee/wikimore:latest instead of privatecoffee/wikimore:latest.
For your convenience, we also provide a Docker image. Note however that this is not the recommended way to run Wikimore.
You can use the bundled docker-compose-example.yml file to run Wikimore with Docker Compose.
cp docker-compose-example.yml docker-compose.yml
docker compose up -d
This will start a container with Wikimore on port 8109. You can change the port in your docker-compose.yml file.
Development
- Clone the repository
git clone https://git.private.coffee/privatecoffee/wikimore.git
cd wikimore
- Create a virtual environment and activate it
python3 -m venv venv
source venv/bin/activate
- Install the package in editable mode
pip install -e .
- Run the application
flask --app wikimore run
- Open your browser and navigate to
http://localhost:5000
Configuration
You can configure Wikimore using environment variables. The following variables are available:
| Variable | Description | Default Value |
|---|---|---|
| WIKIMORE_HOST | Which host / IP to listen on. | 0.0.0.0 |
| WIKIMORE_PORT | Which port to listen on | 8109 |
| WIKIMORE_SOCKET | Path to a UNIX socket to listen on (overrides WIKIMORE_HOST and WIKIMORE_PORT) | (not set) |
| WIKIMORE_DEBUG | Enable debug mode (True if set to any value) | False |
| WIKIMORE_INSTANCE_HOSTNAME | The hostname of your instance, used in the User-Agent header | (auto-detected) |
| WIKIMORE_ADMIN_EMAIL | Email address of the instance administrator, used in the User-Agent header | (not set) |
| WIKIMORE_NO_LANGSORT | Disable custom language sorting (True if set to any value) | False |
| WIKIMORE_LANGSORT | Custom language sorting, comma-separated list of language codes | en,es,ja,de,fr,zh,ru,it,pt,pl,nl,ar |
| WIKIMORE_CACHE_TYPE | The type of cache to use (SimpleCache, FileSystemCache, RedisCache) | SimpleCache |
| WIKIMORE_CACHE_DIR | The directory to use for FileSystemCache (only if WIKIMORE_CACHE_TYPE is FileSystemCache) | /tmp/wikimore_cache |
| WIKIMORE_REDIS_URL | The Redis URL to use for RedisCache (if set, WIKIMORE_CACHE_TYPE is RedisCache) | (not set) |
| WIKIMORE_CACHE_TIMEOUT | The cache timeout in seconds | 3600 (= 1 hour) |
License
This project is licensed under the MIT License - see the LICENSE file for details.
Tag summary
Content type
Image
Digest
sha256:49dbc567b…
Size
34.3 MB
Last updated
12 months ago
docker pull tlan16/wikimore