Skip to main content

Slipway LogoSlipway

Write once, display anywhere.

Slipway is an open source framework for displaying useful information on your devices.

14:1214:12WED14

Display anywhere

Slipway lets you quickly create custom dashboards (called Rigs) that can be displayed on almost any device with a screen. View them in browsers, as phone widgets, on eInk screens, and more.

If you have data in one place and want to display it in another place, Slipway is designed to do that quickly and with minimum fuss.

Reusable Components

By utilizing an ecosystem of Components you can often create custom Rigs with just some JSON and a small amount of code. If someone else has already done what you need, you might not even need any code.

Rigs compose components together, allowing you to mix and match information to create dashboards that are tailored to your needs.

Information when you need it

Using playlists, you can schedule Rigs to be displayed at different times of the day, or on different days of the week.

Perhaps in the morning you want today's calendar alongside train departures, in the afternoon your house solar stats, and in the evening some movie recommendations. Playlists make that trivial.

Designed for simple self hosting

Slipway has been designed to make self hosting as simple, hassle free, and safe as possible.

All you need is a cheap, basic server. There are no databases or other dependencies. Slipway is deployed as a single binary with some static configuration, or as a single Docker image.

Language and renderer agnostic

Slipway lets you write Components in Javascript or any language that compiles to WASM, such as Rust, and mix and match within your Rigs.

Renderers are also just Components. Currently Slipway supports rendering using JSX, SVG, ECharts, Adaptive Cards, or a mix of all of them.

Supports TRMNL out of the box

TRMNL devices are affordable eInk screens for displaying anything you like.

Slipway supports the TRMNL API out of the box, so you can quickly get up and running displaying your Rigs on your TRMNL devices while taking advantage of Slipway's flexible scheduling, playlists and on-demand rendering.

TRMNL, Apple Watch and iPhone displaying Rigs being generated by Slipway
TRMNL showing house Solar, Battery and Power usage.
Apple Watch displaying 20 day GitHub commit graph.
iPhone displaying both 26 day GitHub commit graph and house Solar, Battery and Power usage..
All being generated dynamically by Slipway.

How does it work?

{ }{ }

1. Components gather and format data

Write your own Components, or use Components created by others. Components can be written in Javascript or any language which compiles to WASM, such as Rust.

2. Rigs compose Components together

A Rig is a set of Components rigged together so that data flows from one Component to the next, with the final output being a dashboard showing what matters to you.

24°wedthu 13

3. Slipway hosts Rigs for your devices

Slipway lets you quickly and securely run and host Rigs on your local infrastructure or in the cloud, making them available to all your devices. Playlists let you serve different Rigs to a device depending on the day and time.

24°wedthu 13

4. See the information you want, where you want it

Display your Rigs on any device with a screen, including eInk screens, phone widgets, monitor arrays, and more.