Skip to content

Latest commit

 

History

History
120 lines (95 loc) · 5.21 KB

README.md

File metadata and controls

120 lines (95 loc) · 5.21 KB
Raw

Momos logo

License MIT Build Status

Momos - Reverse proxy to define server-side-includes with HTML5 and attributes. No html comments or complicated configurations. This is a proof-of-concept.

  • Cache: Requests are cached with RFC7234.
  • Fast: SSI Fragments are loaded in parallel.
  • No proxy configs: Everything is configurable via HTML5 attributes.
  • Dev-friendly: Frontend developer can create fragments easily.
  • Fallback: Define default content or an error template with <ssi-error>.
  • Reliable: Define a timeout message with <ssi-timeout>.
  • Just HTML: Define SSI fragments with pure HTML <ssi>.
  • Templating: Use Go Templates inside fragments and ssi tags.
  • Operational: Easy to start and maintain. Single binary.

Why you don't use Nginx?

Good point. Nginx is a great proxy and although it already provides robust SSI directives I would like to see a solution which doesn't require a restart or reload of the proxy when parameters has to be changed. The transition between defining SSI fragments and configure them should be smooth for any kind of developer. Momos should provide a proxy with advanced SSI functionality. Any developer should be able to place and configure SSI fragments with html knowledge.

Momos is compiled to a single binary. It provides great debugging experience to understand how your page is build which is often difficult in proxys like Nginx or Apache.

What are SSI?

SSI (Server Side Includes) are directives that are placed in HTML pages, and evaluated on the server while the pages are being served. They let you add dynamically generated content to an existing HTML page, without having to serve the entire page via a CGI program, or other dynamic technology. Reference

Advantages

  • Easy integration of html fragments from external services
  • Share all layout html fragments to keep them DRY
  • Insert fragments in pages which are usually static (e.g landing)
  • In highly distributed environments it can be an advantage to integrate services on data content

Example

<!doctype html>

<html lang="en">
<head>
  <meta charset="utf-8">
<body>

  <ssi
    name="basket"
    timeout="2000"
    template="true"
    src="http://starptech.de">

    <!-- Used when no error or timeout field was set default empty space -->
    Default content!
    
    <!-- Timeout errors based on the timeout duration-->
    <ssi-timeout>
    <span>Please try it again! {{.DateLocal}}</span>
    </ssi-timeout>
    
    <!-- None 2xx status code or any other error -->
    <ssi-error>
    <span>Please call the support!</span>
    </ssi-error>
  </ssi>
  
</body>
</html>
  • name : The name of the fragment (default unique-id)
  • timeout : The maximum request timeout (default 2000)
  • no-scripts: Filter javascript and css includes from the fragment (default true)
  • src : The url of the server-side-include
  • template : Enables template rendering via go templates (default false)

Run it

$ go test
$ go run examples/server.go
$ go run examples/client.go

Expected output

Requests are cached for 10 seconds max-age=10

__  ___
/  |/  /__  __ _  ___  ___
/ /|_/ / _ \/  ' \/ _ \(_-<
/_/  /_/\___/_/_/_/\___/___/ 1.0.0
High performance, reverse proxy for advanced SSI
2017/08/22 20:10:48.367828 [INF] Fragment "basket3" was cached
2017/08/22 20:10:48.367828 [INF] Fragment "basket4" was cached
2017/08/22 20:10:48.367828 [INF] Fragment "basket5" was cached
2017/08/22 20:10:48.367828 [INF] Fragment "basket2" was cached
2017/08/22 20:10:48.367828 [INF] Fragment "basket" was cached
2017/08/22 20:10:48.367828 [TRC] Call fragment basket3, url: http://localhost:8081/b, duration: 999.5µs
2017/08/22 20:10:48.367828 [TRC] Call fragment basket4, url: http://localhost:8081/c, duration: 999.5µs
2017/08/22 20:10:48.367828 [TRC] Call fragment basket5, url: http://localhost:8081/d, duration: 999.5µs
2017/08/22 20:10:48.367828 [TRC] Call fragment basket2, url: http://localhost:8081/a, duration: 999.5µs
2017/08/22 20:10:48.367828 [TRC] Call fragment basket, url: https://google.de, duration: 999.5µs
2017/08/22 20:10:48.368827 [TRC] Processing complete "http://127.0.0.1:8080/favicon.ico" took "1.9983ms"

Run in production

Momos is no replacement for a reverse proxy like Nginx or Apache. Only the calls to the SSI Services are cached.

TODO

  • Generate useful debug informations about the fragment structure of your page
  • Collect metrics
  • Add headers attribute to pass custom headers to the upstream proxy.
  • Allow fragments to consume specific custom headers from request.

References

Credits

Icon made by author from www.flaticon.com