v0.3.8 · Stable

Run Shio

Agent-ready CMS: models content, renders pages or delivers them over a versioned REST and GraphQL API, and indexes it in Viglet Turing for search.

Run Shio with Docker and create your site.

$ docker run -d -p 2710:2710 --name shio ghcr.io/openviglet/shio-ce

Prefer not to self-host? Run Shio on Viglet Cloud (beta).

View on GHCR

ghcr.io/openviglet/shio-ceApache 2.0 LicenseNo install, runtime bundled

Prerequisites

The only requirement is Docker

Docker

Docker Engine 20+ or Docker Desktop

Any OS

Linux, Windows & macOS

One free port

Port 2710 available on the host

Quick Start

Up and running in minutes

Three steps to get Shio running with Docker.

Pull the image

Pull the latest Shio image from the GitHub Container Registry. The container bundles the runtime, so you install no Java and do no manual setup.

$ docker pull ghcr.io/openviglet/shio-ce

Run the container

Start Shio in the background, mapping the container port to your host:

$ docker run -d -p 2710:2710 --name shio ghcr.io/openviglet/shio-ce

Open localhost:2710Login: admin / admin

Explore the docs

The documentation covers Shio features, environment variables and production deployment with Docker Compose.

Read the Docs

Features

What's included

What ships with Shio.

Content Delivery API

A versioned, read-only REST API: fetch content by id, by URL for slug routing, or by query, and get stable, frozen JSON back.

GraphQL Delivery

A GraphQL schema generated from your own post types, served read-only at /graphql. Query only the fields your front-end needs.

Content Modeling as Code

Model post types in the console, or version your content model as code with the Post Types DSL and the Shio CLI. Push and pull with drift detection.

API Tokens & Environments

Per-environment (prod/preview) keys with READ / PREVIEW / WRITE scopes and per-site allow-lists, protected by rate limiting and ETag / Cache-Control caching.

Draft Preview & Scheduling

Preview unpublished drafts with short-lived tokens, schedule content to go live, and restore earlier versions from the console.

Visual Editing

Edit any externally rendered page inline through the Adobe Universal Editor bridge. The CMS stays decoupled from your front-end.

React & JavaScript SDKs

Official SDKs with hooks (useShioPost, useShioQuery, useShioChildren) to render content with Next.js or any framework, plus outbound webhooks on publish.

Native Cache & Search

Delivery runs on a Hazelcast-backed native cache. Content is indexed automatically, with Viglet Turing integration for enterprise search.

Ready to get started?

Shio is open source and free to use. Pull the image and run it.

$ docker run -d -p 2710:2710 --name shio ghcr.io/openviglet/shio-ce

View on GHCR Documentation