ttax00 / obsidian-s3

An Obsidian plugin for storage and retrieval of media attachments on S3 compatible services.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

S3 attachments storage

GitHub GitHub Workflow Status wakatime

An Obsidian plugin for storage and retrieval of media attachments on S3 compatible services.

Getting started

  • Clone this repo.
  • npm i to install dependencies
  • npm run build to compile to main.js

Manually installing the plugin

  • Copy over main.js, manifest.json to your vault VaultFolder/.obsidian/plugins/your-plugin-id/.

Feature list

Supported files (limited by files allowed to be linked by Obsidian):

  • images (.ico, .png, .jpg, .gif).
  • videos (.mp4).
  • audio (.mp3, .wav).

Upload

  • Upload on paste.
  • Upload on drag-n-drop.
  • Upload on adding attachments.

Retrieval

  • Generate links for images.
  • Generate links for videos.
  • Generate links for audio.
  • Returning download links for un-supported resource? (pdf, txt, ...).

Helpers/Misc

  • Command: delete un-used resources.
  • Command: Show bucket size
  • Rename links on port/foldername changes.

Unplanned

  • Command: upload existing compatible attachments.
  • Parallel uploads.
  • Retry counts and delays.
  • Upload static html sites.
  • Generate links for static html.
  • Resource local caching (may increase incompatibility with mobile).

Many thanks

Inspiration taken from:

About

An Obsidian plugin for storage and retrieval of media attachments on S3 compatible services.

License:MIT License


Languages

Language:TypeScript 93.2%Language:JavaScript 6.8%