mirrors/wikimore
1
0
Fork 0
mirror of https://git.private.coffee/PrivateCoffee/wikimore.git synced 2025-03-31 11:37:35 +03:00
Code Issues Projects Releases Packages Wiki Activity
No description
118 commits 2 branches 11 tags 220 KiB
Find a file
Exact
Kumi bee7319667 Merge pull request 'chore(deps): update docker/build-push-action action to v6' (#53) from renovate/docker-build-push-action-6.x into main 
Reviewed-on: https://git.private.coffee/PrivateCoffee/wikimore/pulls/53
2025-03-04 17:35:03 +00:00
.forgejo/workflows chore(deps): update docker/build-push-action action to v6 2025-03-04 17:03:21 +00:00
.vscode refactor: restructure project for PyPI packaging 2024-07-16 09:58:18 +02:00
src/wikimore feat: Improve category links in article pages 2025-01-31 09:10:56 +01:00
.gitignore chore: Add Docker support to documentation 2025-01-31 09:52:28 +01:00
docker-compose-example.yml feat(ci): migrate to Forgejo Docker registry 2025-02-27 14:19:32 +01:00
Dockerfile chore(deps): update alpine docker tag to v3.21 2025-03-04 16:17:50 +00:00
entrypoint.sh feat: Refactors Docker setup to improve security and efficiency 2025-01-31 09:22:29 +01:00
instances.json chore: Update instance listings & add JSON file 2025-03-02 20:00:44 +01:00
LICENSE feat: initial setup of Wikimore Flask app with basic features 2024-07-11 12:25:19 +02:00
pyproject.toml chore: add executable flag and bump version 2025-02-26 09:15:11 +01:00
README.md fix(docs): Update README table formatting 2025-03-03 07:58:10 +01:00
renovate.json Add renovate.json 2025-03-04 16:12:03 +00:00
requirements-dev.txt chore: update dependencies management for development 2024-08-17 08:26:25 +02:00

README.md

Wikimore - A simple frontend for Wikimedia projects

Support Private.coffee! Matrix PyPI PyPI - Python Version PyPI - License Latest Git Commit

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 🇩🇪 🇪🇺
wm2.bloat.cat Bloat.cat Germany 🇩🇪 🇪🇺
wikimore.blitzw.in Blitzw.in Denmark 🇩🇰 🇪🇺
wikimore.lumaeris.com Lumaeris Germany 🇩🇪 🇪🇺
wikimore.darkness.services Darkness.services United States 🇺🇸
wp.dc09.ru dc09.ru Russian Federation 🇷🇺

Tor Hidden Services

URL Provided by Country Notes
wikimore.coffee2m3bjsrrqqycx6ghkxrnejl2q6nl7pjw2j4clchjj6uk5zozad.onion Private.coffee Austria 🇦🇹 🇪🇺
wikimore.darknessrdor43qkl2ngwitj72zdavfz2cead4t5ed72bybgauww5lyd.onion Darkness.services United States 🇺🇸

Adding Your Instance

To add your own instance to this list, please open a pull request or issue, 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

  1. Create a virtual environment and activate it
python3 -m venv venv
source venv/bin/activate
  1. Install the package from PyPI
pip install wikimore
  1. Run the application
wikimore
  1. Open your browser and navigate to http://localhost:8109

Docker

Notice: The Docker image is now 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. The Docker Hub deployment may be removed in the future.

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

  1. Clone the repository
git clone https://git.private.coffee/privatecoffee/wikimore.git
cd wikimore
  1. Create a virtual environment and activate it
python3 -m venv venv
source venv/bin/activate
  1. Install the package in editable mode
pip install -e .
  1. Run the application
flask --app wikimore run
  1. Open your browser and navigate to http://localhost:5000

License

This project is licensed under the MIT License - see the LICENSE file for details.