Skip to content
Caelestis

Recent changes

The most recent edits to this wiki, newest first.

  • Authentication and tokens A token grants access to one Caelestis server. The server owner decides who receives one. Scope Allows Read Published templates, progress, and other read only server data.
  • Caelestis Caelestis adds image templates and painting tools to Wplace. Import your artwork, place it on the map, and adjust the overlay to see where each colour belongs. You can use it on your own without a server.
  • CNPG Docker stack Runs Caelestis in Docker against an existing CloudNativePG database. It does not install CNPG or create a Kubernetes cluster. If Caelestis will run inside Kubernetes too, use Kubernetes with Helm .
  • Connect to a server Connect to use a group's shared templates, progress, and collaboration tools. Ask the server owner for its address and an access token. Your local templates stay in this browser and remain separate from the server.
  • Container images The backend and frontend are separate images. Use the tested pair from the same server release. Image Docker Hub GHCR Backend Frontend The release workflow builds and .
  • Contributing For bugs, include steps that reproduce the problem. For a larger feature, open an issue before implementing it so its scope can be discussed. Choose an issue type.
  • Dashboard The dashboard shows a server's published templates and their recorded progress. It does not show templates stored only in your browser. Open the URL your server owner gives you, or visit the official dashboard.
  • Deploy on Cloudflare This guide deploys two Workers in your Cloudflare account: the backend and the dashboard. The backend uses D1, R2, and Durable Objects. Use the self hosted configuration examples.
  • Deployment and upgrades Update the backend and frontend together. Use the image references from one server release, or build both from the same checkout. Stop application writes and take a matching database and object backup.
  • Docker Compose stacks Every stack starts with , which runs the backend and frontend. Additional Compose files replace the database or object storage settings. Database Filesystem objects Local MinIO objects SQLite Base + PostgreSQL Base + Base + PostgreSQL + S3 files MariaDB Base + Base + MariaDB + S3 files Existing CNPG
  • Documentation screenshots Docs screenshots live in . The source repository's README images live in . For a UI instruction, show the state where the reader takes the action.
  • Getting started This guide places a local template on Wplace. You need the userscript installed and an image to paint. You do not need a Caelestis server.
  • Install the userscript Install a userscript manager in your browser, then add Caelestis from GitHub. The example below uses Violentmonkey. Choose Violentmonkey or Tampermonkey and follow its link for your browser.
  • Kubernetes with Helm The chart runs the backend and frontend in one Pod. It creates a Service, an optional Ingress, and an optional persistent volume claim. You supply the database, object bucket, credentials, and TLS configuration.
  • Maintainer reference These repository documents cover implementation and operation beyond the user guides. Self hosting reference: runtime variables, adapters, migrations, and deployment details. Stack testing: deployment test matrix and CI setup.
  • MariaDB Docker stack Runs the backend, dashboard, and MariaDB 11.8 on one Docker host. Artwork and tile objects stay in the volume.
  • Overlay and painting The overlay shows your template over Wplace. Its appearance affects what you see, not the artwork stored in the template. Open Appearance in the Caelestis panel header.
  • PostgreSQL Docker stack Runs the backend, dashboard, and PostgreSQL 17 on one Docker host. Artwork and tile objects stay in the volume. Complete the checkout and common settings in Run with Docker .
  • Progress and collaboration Caelestis compares template colours with the canvas to show what is complete and what still needs work. A connected server shares those observations with other painters. In the template panel, expand a row's progress.
  • Run with Docker This setup runs the backend and dashboard on one machine. It uses SQLite for records and Docker volumes for artwork and tile history. The commands below build from source.
  • S3 object storage S3 holds template artwork, tile blobs, and social images. It does not replace the relational database. You can combine S3 with SQLite, PostgreSQL, MariaDB, or CNPG.
  • Self-hosting Run your own Caelestis server to share templates and progress with a group. The backend stores the data; the frontend serves the dashboard and forwards userscript requests. Setup Database and artwork storage Guide Docker, default SQLite and files in Docker volumes Run with Docker Docker with Postgre
  • Settings and shortcuts Click the gear in the Caelestis panel header to open Settings . These preferences and server connections belong to this browser. Each server has an address and its own access token.
  • Storage and backups This page covers the Docker and Kubernetes runtimes. A complete portable backup has two parts: the database and application objects. The database alone cannot restore template images or tile history.
  • Templates A template is artwork placed at a position on Wplace. Caelestis lists local, server, and native Wplace templates in the panel. Hover Local and click its import icon, outlined below, or click Import a template beneath the list.
  • Troubleshooting Check that your userscript manager lists Caelestis and that it is enabled. Reload Wplace after installing or updating. On Chromium browsers, check whether your manager requires Allow User Scripts or extension developer mode.
  • Userscript guide The userscript adds Caelestis to Wplace. Use the panel to manage templates and settings, and the map controls while painting. If this is your first visit, install the userscript and place a template .

Caelestis ยท Published with Svartz