ssddanbrown / webby

A tiny static webserver app written in go

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Webby

A windows-focused tiny static web server app written in go. It features HTML file live-reload functionality built in which will also dynamically reload linked CSS files.

On windows, Webby sits in the windows taskbar. When clicked the management interface will open via a browser. You can exit webby by right-clicking this icon.

My experience of writing in Go is limited so there's likely to be some inefficiencies & bugs.

Installing and usage

To install webby simply download the webby.exe file from the latest release here and place somewhere in your system.

There are a few ways to use the webby.exe program:

  1. Set webby as the default HTML file program (Recommended):
    • Right click a HTML file.
    • "Open with" > "Choose another app".
    • Scroll to bottom > "More Apps".
    • Check "Always use this app" checkbox.
    • Scroll to bottom > "Look for another app on this PC".
    • Select the webby.exe file.
  2. Drag HTML files onto the webby.exe file.
  3. From the command line, execute webby.exe followed by a html file you want to open:
    webby.exe hello.html

When running for the first time you may get a 'Windows Smartscreen' warning.

Security Considerations

When ran, Webby makes the entire directory structure below the file/folder location it's used available on a port between 8000 & 9000. Anyone with access to that port on your pc could sniff around and search for files on your system.

Upon the above, Someone with access to port 35729 on your machine could create new servers at any directory they want then access via the above method.

It is recommended to only use webby behind a firewall on networks you trust due to the above security concerns.

Project Goals

  • Should be focused on static HTML/CSS/JS development.
  • Should be super simple to use.
  • Should be lightweight.

Libs used

These awesome libraries have been used in webby:

  • github.com/fatih/color
  • github.com/howeyc/fsnotify
  • golang.org/x/net/websocket
  • github.com/GeertJohan/go.rice
  • github.com/akavel/rsrc
  • github.com/lxn/walk
  • github.com/livereload/livereload-js

License

Webby is licensed under the MIT License.

About

A tiny static webserver app written in go


Languages

Language:Go 87.5%Language:HTML 8.0%Language:Shell 2.2%Language:CSS 2.2%