zettelkasten-inspired image library
| public | fancy tags + start phasing out links | |
| views | improving paging | |
| initdb.sh | initial commit | |
| mime-filter.sh | initial commit | |
| README | make registration more efficient | |
| windle.rb | bugfix for tag search | |
===== windle ===== Windle is a tool for organizing and viewing image collections, inspired by the Zettelkasten method. It consists of a web server for browsing collections in a human-friendly way, and a command-line interface for managing indexed content. Important: As a local image-viewing tool, windle isn't designed with security in mind. It should NEVER be run on a public web server, or in any other situation where anyone else is using it besides yourself. If you disregard this warning, there will be DIRE CONSEQUENCES. ----- usage ----- Dependencies: - sqlite3 - ruby (plus sinatra, sqlite3, and puma gems) Windle uses an sqlite database to store tags, file paths, and links. It expects the database to be located in either an environment variable called WINDLE_DB, or if that's not set, the file ~/.local/share/windle/default.db. To create a new database, run ./initdb.sh PATH_TO_DATABASE. All of windle's code lives in windle.rb. You can run windle.rb with the following flags: --add FILES add files to the database --remove FILE remove a file from the database --check print out (and optionally fix) missing files --check-tags print out registered but untagged files --run [PORT=80] run a web server at PORT --help print a summary of available flags. Windle's web server provides an interface for browsing the image library, updating tags, and searching. It uses very basic HTML and CSS, and doesn't use any JavaScript. You can customize windle's behavior by changing the source code. Here are some things you might be interested in modifying: - the default database location - @@page_size (number of images per 'page' of search results) - @@table_width (number of images per row of search results) - front-end style (./public/css/style.css) - error image (./public/not-found.png) ----- etc ----- This is mostly just a tool for my personal use, so documentation is sparse and not up-to-date. Feel free to try it out, fork it, contribute, etc; but no guarantees are made as to its security or stability. Enjoy!