My home-built database solution for managing personal data and interacting with other projects.

Current features include:

• Full support for modern Android/iOS mobile as well as desktop browsers.
• A fully featured library/book cataloging system: type the name of a book, click the correct match, then scan a QR code, barcode, or RFID tag. Bam, it's now cataloged under your name, and you can easily find it later, specify if someone's borrowing it, transfer ownership, etc.
• Arbitrary item inventory system: similar to books, but meant for catalogging stuff like tools, furniture, etc.
• File storage with advanced tagging functionality and minimal limitations. Want to upload 75 photos of your dog? Can do, just select them all and add the "dog" and "my-dog's-name" tags when uploading. Has it been 10 years and you can't find those images? Just search for your dog's name. Want to download all the results from that search? Just click the "download all" button. Don't want anyone else to see that video of you in a tutu? Just mark the file as "only visible to me".
• Allow users to report bugs, request new features, and see what features are planned or in progress.
• Weather Alerts integration: if you moved, changed your phone number, want to change the default temperature thresholds, or just disable your alerts altogether, you can do so in the user settings page.
• Subsonic Music Server Integration: Search albums, and interact with the Library to show what books also have an audiobook version.
• Dynamic theme: If you don't like the default colors or styling, you can always change it in user settings.
• Data feeds: Allow the server to automatically fetch content from across the web, e.g. regularly-updated webcomics or serials; getting a guaranteed notification when new updates come out.
• Fine-grained user control:
  • User Isolation: Sometimes you don't want certain groups of users to interact (e.g. in-laws, different friend groups, etc). If that's the case, admins can assign a "group" to users. Any users not in the same group will not be able to see or interact with each other's data.
  • User Permissions: Control what type of actions users are allowed to do, and what they're allowed to see.
• Bot friendly: admins can generate API tokens to allow bots or other services to securely make requests. These tokens can have the same permissions restrictions applied to them as users! Check out the Python API repo for a fast way to get started.

Every one of the above features is fully optional, and can be disabled from the admin options, on a per-group basis, and individually by each user.

Setup

This application requires some flavor of Linux (tested on Ubuntu 22 and 24), Python ≥ 3.10, MongoDB ≥ 5, and OpenJDK ≥ 8.

To get all set up, first download the repo, then install dependencies:

git clone https://github.com/ZacharyWesterman/skrunk.git --recursive
cd skrunk
poetry install

If you plan to enable the file module, you'll want to make sure you have a place to store blob data that is uploaded to the site. It can be any directory, but going forward we'll assume it's /var/blob_data.

Also, make sure you know the MongoDB URL of the database. If not specified at run-time, this will default to localhost.

To run this application with minimal params:

./run.sh --blob-path=/var/blob_data

Additional parameters are available. You can run ./run.sh --help to see them all.