Skip to content

Improve documentation and usability of running a Tiled server#1313

Open
danielballan wants to merge 32 commits intobluesky:mainfrom
danielballan:server-docs
Open

Improve documentation and usability of running a Tiled server#1313
danielballan wants to merge 32 commits intobluesky:mainfrom
danielballan:server-docs

Conversation

@danielballan
Copy link
Copy Markdown
Member

@danielballan danielballan commented Mar 19, 2026

  • New docs page streamlines running a single-node Tiled server, with or without containers.
  • New docker-compose.yml stands up PG (catalog and storage databases) and Redis.
  • New catalog: section is config makes doing standard setups much simple (no need for complex trees:).
  • Config schemas use pydantic-settings, which adds automatic support for using env vars to specify any config, not just some. This simplifies docker-compose etc.

Needs:

  • Configuration example for reference
  • In or next to configuration example, explain use cases for trees: (1) advanced routing involving read replicas, (2) experimentation with alternative catalog implementations, (3) legacy management (databroker)
  • Placeholder page for multi-node deployment (to be expanded later)

Checklist

  • Add a Changelog entry
  • Add the ticket number which this PR closes to the comment section

@danielballan danielballan marked this pull request as ready for review March 23, 2026 13:59
USER root
COPY docker-entrypoint.sh /usr/local/bin/docker-entrypoint.sh
RUN chmod +x /usr/local/bin/docker-entrypoint.sh
ENTRYPOINT ["docker-entrypoint.sh"]
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Won't chowning the volume from within the container change the ownership of the files outsdie the container, those mounted on /storage?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. Same as would happen with PG or Redis.

It matters that this "storage" is all Tiled-controlled: the catalog, Zarr and Parquet data written by the server, etc. Any externally managed data would have to be separately managed, and explicitly/manually set with compatible permissions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants