Skip to content

bahleg/OBSIFLASK

Repository files navigation

OBSIFLASK logo

OBSIFLASK

Simple web service for Obsidian vaults

CI codecov

OBSIFLASK is a lightweight web service for Obsidian vaults, built on Flask.
It supports multiple vaults, multi-user mode, search and navigation, background tasks, and graph visualization.


🚀 Features

  • 🌐 Web UI — clean and convenient interface for note browsing and edit
  • 📚 Multi-vault support — work with multiple vaults at once
  • 👥 Multi-user support — run OBSIFLASK in multi-user mode, where each user has their own vaults and permissions
  • 🔎 Advanced search — exact search, regex, fuzzy search, tag search, link search, and filter-based search
  • 📝 Task scheduler — run periodic shell tasks per vault with logs and messages
  • Graph visualization — global graph rendering, filtering, tag coloring, clustering
  • 🔐 Encryption & Obfuscation — hide or protect sensitive content using Meld-compatible encryption or lightweight obfuscation

📸 Check the obsiflask UI screenshots and visual comparison with Obsidian


📦 Getting Started

For OBSIFLASK configuration, please see Config file and example yaml file for details.

With an example config, the server will be started at http://localhost:8000.

Python pip

git clone https://github.com/bahleg/obsiflask.git pip install . obsiflask ./example/config.yml

or

pip install git+https://github.com/bahleg/OBSIFLASK.git 

Docker

docker run -p 8000:8000 bahleg13/obsiflask:latest

By default docker image uses config from /config.yml. You can use the docker with your config:

docker run -p 8000:8000 -v <path to your config>:/config.yml bahleg13/obsiflask:latest 

🤝 Contributing

This is a personal pet project that I develop in my free time.
Expect plenty of bugs, missing features, and rough edges 🙂

That said — feedback, issues, and pull requests are very welcome!
If you have ideas, suggestions, or fixes, feel free to open an issue or submit a PR.

More