microsoft/fluidframework-routerlicious-historian repository overview

⁠Fluid Framework Reference Service - Historian

⁠Featured Tags

• latest: docker pull mcr.microsoft.com/fluidframework/routerlicious/historian:latest

⁠About This Image

Historian provides a REST API for Fluid summaries. A Fluid summary is the "summarized" state of a Fluid document at a point in time; new summaries are created periodically while new operations are added to the document. Clients and users connect directly to Historian to upload these summaries. Historian makes rest calls to the storage provider and caches data locally.

More information on Summaries can be found at FluidFramework.com⁠.

Historian is a cached proxy for an underlying file storage system. In the reference implementation, Historian provides a Redis backed cache access to GitRest. While Historian prefers to store summaries in git, it permits any storage as long as Historian can fulfill its API.

⁠How to Use this Image

To use this image, follow the instructions on using our Docker-Compose file⁠.

⁠Configuration

• This image requires Docker Engine 2.0+ in any of their supported platforms⁠
• At least 4GB of RAM. Make sure to assign enough memory to the Docker VM if you're running on Docker for Mac⁠ or Windows⁠

⁠Related Repos

Microsoft/FluidFramework⁠

⁠Support

If you have any problems with or questions about this image, please contact us through a Github Issue⁠

⁠Feedback

Please provide feedback to Feedback⁠

⁠License

• Legal Notice: Container License Information⁠
• Fluid Framework is licensed under the MIT license⁠

⁠Trademark

This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services. Use of these trademarks or logos must follow Microsoft's Trademark & Brand Guidelines⁠. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.