https://github.com/bahleg/obsiflask
Simple web service for Obsidian vaults
https://github.com/bahleg/obsiflask
flask-application markdown-editor markdown-previewer markdown-viewer note-taking-app note-taking-application note-taking-service obsidian obsidian-community obsidian-graph obsidian-md obsidian-vault
Last synced: 24 days ago
JSON representation
Simple web service for Obsidian vaults
- Host: GitHub
- URL: https://github.com/bahleg/obsiflask
- Owner: bahleg
- License: gpl-3.0
- Created: 2025-08-29T10:52:58.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-09-20T22:05:35.000Z (8 months ago)
- Last Synced: 2025-09-20T23:31:55.105Z (8 months ago)
- Topics: flask-application, markdown-editor, markdown-previewer, markdown-viewer, note-taking-app, note-taking-application, note-taking-service, obsidian, obsidian-community, obsidian-graph, obsidian-md, obsidian-vault
- Language: Python
- Homepage:
- Size: 10.4 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
- Roadmap: roadmap.md
Awesome Lists containing this project
README
OBSIFLASK
Simple web service for Obsidian vaults
[](https://codecov.io/gh/bahleg/OBSIFLASK)
**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](https://github.com/meld-cp/obsidian-encrypt) or lightweight obfuscation
[📸 Check the obsiflask UI screenshots and visual comparison with Obsidian](gallery.md)
---
## 📦 Getting Started
For OBSIFLASK configuration, please see [Config file](https://github.com/bahleg/OBSIFLASK/blob/main/obsiflask/config.py) and [example yaml file for details](example.yaml).
With an example config, the server will be started at http://localhost:8000.
### Python pip
```bash
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
```bash bash build_docker.sh
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 :/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
* [License: GPLv3](LICENSE)
* [Changelog](changelog.md)
* [Roadmap](roadmap.md)