Skip to content

Latest commit

 

History

History
68 lines (53 loc) · 2.42 KB

README.md

File metadata and controls

68 lines (53 loc) · 2.42 KB
Raw

Vywrs

Vywrs is a complete rewrite of vyw, a files and images browser which only need nginx as backend.

Vywrs is written in rust, and supposed to be compiled into wasm format, this is possible thanks to yew.

Vywrs config is identical to vyw, in addition vywrs now has list view mode to complement thumbnail view.

how to build

  • Ensure you have rustup and stable Rust instalation (> 1.39)
  • Install wasm32-unknown-unknown build target with rustup
  • Follow "Getting Started with Trunk".
  • Run trunk serve to run vywrs in development mode
  • Run trunk build --release and serve dist/ folder in HTTP server to run vywrs in release mode

build result will be available under dist folder.

how to serve under specific directory

By default, the compiled assets are configured to be served under / folder. If we want to serve it under specific directory, use --public-url at trunk build, i.e.

$ trunk build --release --public-url viewer

The command above will configure assets to be served under /viewer directory.

vywrs configuration

The default configuration is provided at static/vywrs.config.js, we will need to copy this file to static/vywrs.config.local.js before compilation or further customisation.

server configuration

vywrs make use nginx json format for file listing, e.g.

[
{ "name":"bower_components", "type":"directory", "mtime":"Wed, 05 Sep 2018 09:10:11 GMT" },
{ "name":"css", "type":"directory", "mtime":"Fri, 31 Aug 2018 00:07:35 GMT" },
{ "name":"img", "type":"directory", "mtime":"Wed, 26 Sep 2018 10:50:09 GMT" },
{ "name":"js", "type":"directory", "mtime":"Wed, 05 Sep 2018 06:24:15 GMT" },
{ "name":"index.html", "type":"file", "mtime":"Fri, 07 Sep 2018 02:42:57 GMT", "size":730 }
]

Another server may be used if it can be configured to serve listing in the previous format.

For nginx, configuration may look like this:

location = /index.json {
  index '*';
  autoindex on;
  autoindex_format json;
  rewrite ^ /$arg_p/ break;
  add_header Access-Control-Allow-Origin "*";
}

The above configuration may be used as the following:

http://localhost/index.json?p=<PATHNAME>

3rd party libraries

This app invoke and re-bind some methods from GLightbox, which licensed under MIT.