Use the README to get some basic information about cState.

• cState Core (you are here)
  • Badges Integration (v4.1)
• cState HTML Embed
• cState CLI
• cState Monitor Bot

Please note the Monitor Bot and CLI tools work best with cState version 6 and up.

Install & upgrade

Migration guides

• Migrating from v5 to v6
• Migrating from v4 to v5
• Migrating from v3 to v4
• Migrating from v2 to v3

Docker (v5)

Docker (v4.3)

Altering configuration file

Adding or editing pages

Creating incidents

• Method 1 - Create a new file manually
• Method 2 - Create incident with CLI / SSH
• Method 3 – Create incident from Web UI

Create incidents automatically – Setting up monitoring

Experiments (v6+)

Announcing maintenance. Informational posts (pinned or not) [v5.2+]

API (v5)

API (v4)

Basic

• Changing site name
• Changing site URL
• Changing site language
• Changing site description
• Changing date formats (v3.0)
• Tabs
• Google Analytics
• Disable complex calculations (v4.1)
• Hiding incident history (v4.2)
• Customize incident history display (v6)
• Uptime histogram (v6)

Time

• Relative time (v5)
• Skip seconds (v5)
• Changing date formats (v3)
• Last modified (v5)

Systems

Categories (v4.0)

Design

• Changing header
  • Height / size
  • Title / logo
  • Site title text color (v4.0.1)
• Color
• Incidents per page
• Enable sorting / archives by year or month (v4.0)
• Dark mode (v4.0)

Developer

• File storage
• Custom HTML

Available translations

Add your own