# Readme Sync

Readme Sync is a LinuxServer container that synchronizes content for the Readme documentation platform with configured sources. It is open source and self-hosted, installable on Docker Hub.

Canonical page: https://ourlocalhost.com/app/3941/readme-sync

## Description

Readme Sync is a LinuxServer container that synchronizes content for the Readme documentation platform with configured sources. It is intended for homelab users or teams that maintain Readme docs and want a repeatable, containerized way to keep them current.

## Platform availability

Available on 1 of 10 platforms: ZimaOS.

## Health score

12/100 (Low), based on 2 of 4 factors.
- Maintained: 0 (GitHub repository no longer exists)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Documentation: https://docs.readme.com
- Official website: https://readme.com/
- Docker Hub: https://hub.docker.com/r/linuxserver/readme-sync

## Common questions

### Can I connect Readme-sync to a GitHub repository for two-way documentation sync?

Yes, you can connect your project to a GitHub repository for bi-directional sync. The docs also cover the permissions you need and how to change repositories.

### Can I import existing API docs instead of creating everything in the editor?

You can import from a URL, OAS, or Markdown, or start from scratch.

### How do I configure Readme-sync behind Cloudflare or a reverse proxy?

Check the Custom Domain and SSL guidance for using a reverse proxy and turning off the Cloudflare proxy.

### Can I keep documentation internal and control login expiration?

The system configuration documentation includes sections for internal documentation and login expiration.

---
Source: Our Local Host (https://ourlocalhost.com/app/3941/readme-sync), the self-hosted and open-source app directory.
