Skip to content

elias-sundqvist/obsidian-static-file-server

Repository files navigation

GitHub release (latest SemVer) GitHub All Releases

Obsidian Static File Server

This is a plugin for Obsidian (https://obsidian.md).

It allows you to host obsidian subfolders as static file servers.

Why?

There are a number of reasons why one might want to do this

  • Embed websites in your vault that work offline
  • Embed websites with CORS issues
  • Access your vault files from other applications

Demonstration

Getting Started

  1. Install the plugin
  2. Make a folder in your vault
  3. Put some files in the folder
  4. Open Static File Server Settings and enter the name of the folder and a port number.
  5. You can now display the files in an iframe
    • For example, a file called example.html could be accessed with
      <iframe src="http://localhost:1337/example.html"/>

FAQ

Contributing

Feel free to contribute.

You can create an issue to report a bug, suggest an improvement for this plugin, ask a question, etc.

You can make a pull request to contribute to this plugin development.

Changelog

0.0.4 (2021-06-08) Minor Bug fix

  • Hopefully resolved issue #1. Ports are now always validated before the servers are started.

0.0.3 (2021-05-04) Minor fixes

  • Fix various issues mentioned by lishind in (this the community plugin list PR)[obsidianmd/obsidian-releases#304 (comment)]
  • Remove error logging (error messages can still be found in the network tab of developer tools.)

0.0.2 (2021-05-04) Fixed misleading setting placeholder

  • The folder path should not be prefixed with a /. Changed the placeholder from e.g. /somepath to e.g. FolderName

0.0.1 (2021-05-04) First Release

  • Basic functionality of the plugin implemented

License

Obsidian Static File Server is licensed under the GNU AGPLv3 license. Refer to LICENSE for more information.