Skip to content
Back to search

minder-publish

Self-hosted publishing for AI-generated HTML reports, files, and static sites. Share a link, control access, and update the content at the same URL.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/s1lash--minder-publish/badge.svg)](/listings/s1lash--minder-publish)

HTML

<a href="/listings/s1lash--minder-publish"><img src="/api/listings/s1lash--minder-publish/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 227 lines
  1. # minder publish.
  2. Turn an HTML report from your AI agent, a PDF, or a built static site into a link
  3. on your own server. Share it with your team, require a password, or keep it for
  4. yourself. Publish updates at the same address.
  5. One instance has one owner. The browser cabinet searches your publication history;
  6. the CLI and skills let an agent publish actual files. An optional MCP adapter uses
  7. the same API. Each instance manages its account and data locally.
  8. Review the required [security acceptance checks](docs/SECURITY.md#release-acceptance)
  9. before exposing a self-hosted build publicly.
  10. [Set up with your agent](#run-your-own-instance)
  11. ## Watch the demo
  12. [![Watch the 50-second Minder Publish demo](https://publish.minder.world/assets/publish-demo-poster.webp)](https://publish.minder.world/#demo)
  13. Follow one report from an agent’s terminal to a phone, then update and share it at the same address. [Open a sample publication](https://publish.minder.world/example/).
  14. - [Publish a Claude artifact as a website](https://publish.minder.world/guides/publish-claude-artifact/)
  15. - [Share an HTML file with a password](https://publish.minder.world/guides/share-html-with-password/)
  16. ## Run your own instance
  17. Set up one server, then connect the agents you already use.
  18. 1. **Deploy Minder Publish.** Start from a tagged source release. Follow the
  19. Docker Compose guide for your server, domain and TLS. Create the owner account,
  20. check server health and sign in to the cabinet.
  21. [Latest release](https://github.com/S1lash/minder-publish/releases/latest) · [Self-hosting guide](docs/SELF_HOSTING.md)
  22. 2. **Install the CLI and skill in your coding agents.** In the cabinet, go to
  23. **Connection**, choose **Codex** or **Claude Code**, and click **Copy setup
  24. instructions**. Paste the result into that agent. Repeat for each runtime and
  25. machine you use, including remote machines where the files live. The installer
  26. sets up both the CLI and its skill. When asked for a token, use **Create token**
  27. with **Manage materials**, run the exact command reported by the installer, and
  28. enter the token at its hidden prompt. Open a fresh chat to load the new skill.
  29. Other agents with terminal access can use the CLI and install the skill if
  30. supported. [CLI and skill setup](#connect-the-cli)
  31. 3. **Connect ChatGPT and Claude.** Enable remote MCP on your instance, then
  32. open **Connection → ChatGPT** or **Claude**. Start on the web and follow the
  33. steps to authorize the custom app or connector and choose when it asks for
  34. approval. Download the skill ZIP there and import it if your account
  35. supports skills. Try the connected app and skill in a fresh chat on each
  36. device you use, including your phone. OpenAI documents full custom MCP
  37. support for eligible ChatGPT Business and Enterprise/Edu workspaces on the
  38. web. If a client offers only read access or its connected app is unavailable,
  39. publish from the cabinet or CLI and keep the same instance.
  40. [Connection guide](docs/SELF_HOSTING.md#connect-an-ai-tool) ·
  41. [ChatGPT app availability](https://help.openai.com/en/articles/12584461-connecting-custom-mcp-servers-in-chatgpt) ·
  42. [Claude connector availability](https://support.claude.com/en/articles/11176164-use-connectors-to-extend-claude-s-capabilities)
  43. 4. **Make one test publication.** Create a small HTML page with sample text,
  44. open its link on your phone and update it from another connected client.
  45. Check that the new version opens at the original address. Use
  46. **Settings → Publication defaults** to set the access and expiry you want
  47. for future publications.
  48. ### Give this to your coding agent
  49. ```text
  50. Help me set up Minder Publish from https://github.com/S1lash/minder-publish.
  51. Follow the project's self-hosting guide and use a published release tag. If I already have an instance,
  52. verify its URL and health. Otherwise deploy to my chosen server and domain,
  53. then verify HTTPS and help me sign in as the owner.
  54. Set up the coding agents, ChatGPT and Claude that I use by following the
  55. Connection page. If you cannot reach my signed-in cabinet, ask me to paste its
  56. Copy setup instructions text for the relevant coding agent. Do the steps you
  57. can, and guide me through sign-in, authorization or skill upload where needed.
  58. For a new connector, ask how often it should request approval.
  59. For a new CLI token, give me the installer's exact terminal command and ask
  60. me to use its hidden prompt. Keep passwords and tokens in private prompts or
  61. sign-in forms. Tell me which clients you can verify, and use the cabinet or
  62. CLI if a cloud client has no write access.
  63. Publish a small HTML page titled "Publish setup check" with sample text,
  64. link access and a one-day expiry. Save the returned material ID and stable link.
  65. Open the link, then update that ID to say "Version 2" without changing access
  66. or expiry. Verify the new content at the original link. If a second client can
  67. publish, use it for the update. Return the link and say what I can check on my
  68. phone if you cannot test the phone yourself.
  69. ```
  70. ## What you can publish
  71. - Any ordinary file, including HTML, documents, images, audio, video and archives.
  72. - A built static site: a directory through the CLI, or an explicitly selected ZIP
  73. through the cabinet. The service does not run your build scripts.
  74. - A new immutable revision under the same stable link, preserving omitted metadata,
  75. access, password, expiry and cleanup rules.
  76. Choose owner-only, link or password access. Access expiry, file cleanup and record
  77. retention are separate policies. The owner can open protected materials through an
  78. active session, search by title/description/filename, pause, extend, expire or delete
  79. publications. Access badges identify password-protected materials; checkbox filters
  80. include expired and deleted-file records on demand. The owner can copy a saved
  81. publication password after recent authentication. New-publication defaults and
  82. storage limits are configurable. The UI
  83. ships in English, Russian, Spanish and French, with light, dark and system themes.
  84. Opening a material as its owner shows a thin management rail around the original
  85. document. The side menu previews saved versions, restores one as a new current
  86. version, copies the stable link or password, and shows guest-opening counts.
  87. **View without owner tools** opens the original separately; **Check guest access**
  88. checks the real password/access gate without counting an opening. The choice to
  89. show owner tools is remembered in this browser. History retention fits inside the
  90. instance storage quota; see [revision history](docs/REVISION_HISTORY.md).
  91. Use **Edit link** in the cabinet or the owner menu to give a publication a named
  92. address. The previous address stops working by default. Keep it when recipients
  93. still need it, and disable it later from the same menu.
  94. Shared links expose messenger-friendly titles, descriptions and a brand thumbnail.
  95. Protected materials use a generic card without revealing their contents. See
  96. [link previews](docs/LINK_PREVIEWS.md) for platform behavior and deployment requirements.
  97. Static sites can include a raster image for their library cover.
  98. See [site covers](docs/implementation/API.md#site-covers) for bundle filenames.
  99. Password protection is an access gate, not encryption. Author HTML runs on isolated
  100. revision origins. Read [the security model](docs/SECURITY.md) before sharing sensitive
  101. or executable material.
  102. ## Supported environments
  103. - **Server:** Docker Compose with Linux containers on a Linux host such as an Ubuntu
  104. VPS, or on macOS with OrbStack. Python for the server ships in the container.
  105. - **CLI and local skills:** Python 3.10 or later on Linux or macOS. Install the CLI
  106. on the machine where the agent reads the files you want to publish.
  107. For discussion of other environments, see [Contributing](CONTRIBUTING.md).
  108. ## Connect the CLI
  109. The [recommended setup](#run-your-own-instance) verifies the instance's installer
  110. and checks the connection. Each runtime's skill remembers its selected instance
  111. and verifies it before publishing. The supplied Docker image includes the
  112. CLI-only release wheel. See [the self-hosting guide](docs/SELF_HOSTING.md#connect-an-ai-tool)
  113. for supplying the wheel with a direct source installation.
  114. To install the CLI manually, use an isolated Python environment and an inspected
  115. source release:
  116. ```sh
  117. python -m pip install .
  118. minder-publish configure home --url https://publish.example.com
  119. minder-publish doctor --brief --json
  120. ```
  121. `configure` prompts privately for a device token created in the cabinet. For
  122. noninteractive setup, use `--token-stdin` or a private `--token-file`; never put the
  123. token in an argument, a URL, a skill or model context. Named instances are selected
  124. with `--instance NAME`. To connect through environment variables, pair
  125. `MINDER_PUBLISH_URL` with `MINDER_PUBLISH_TOKEN` or `MINDER_PUBLISH_TOKEN_FILE`.
  126. A complete pair supplies the connection independently of saved profiles. Unset
  127. these variables to use a named profile. Configuration uses your user profile.
  128. Redacted configuration
  129. is available with `minder-publish config --json`.
  130. The selected instance applies across project directories. Use another named
  131. instance explicitly when you want another destination. Omit `--brief` from doctor
  132. to inspect the full server capabilities.
  133. ```sh
  134. minder-publish preflight ./report.html --kind file --json
  135. minder-publish publish ./report.html --kind file --title "Research report" --json
  136. minder-publish preflight ./dist --kind site --entry index.html --json
  137. minder-publish publish ./dist --kind site --entry index.html --access link --expiry default --json
  138. minder-publish list --query "Research report" --json
  139. minder-publish update MATERIAL_ID ./report-v2.html --kind file --json
  140. ```
  141. After reviewing preflight, pass its `manifest_sha256` with `--expect-manifest HASH`
  142. to publish or update. If content or the site entry changed, the client stops before
  143. upload; review the new manifest before retrying. This guard covers content, not
  144. access or expiry policy. Dependency scanning covers static HTML/CSS references;
  145. empty findings do not guarantee that a site works offline.
  146. Private publications normally have no expiry; external links use the instance's
  147. external default. A ZIP remains a file unless site mode is explicit. Preflight
  148. reports included files, sensitive-name exclusions, paths and sizes. Review it before
  149. sending anything; do not bypass exclusions without inspecting the affected files.
  150. Use the server-returned `stable_url` rather than constructing a link.
  151. ## Add skills or MCP
  152. The combined setup installs the skill automatically. For a separate skill repair
  153. or installation, preview its diff first, then apply the managed files you reviewed.
  154. Use `--instance NAME` to select its preferred instance; otherwise the saved CLI
  155. default is selected. The preview reports the instance and server URL:
  156. ```sh
  157. minder-publish skills --runtime all
  158. minder-publish skills --runtime all --apply
  159. ```
  160. The installer changes only the named managed skill; it refuses to overwrite an
  161. unmanaged skill. Other tools can use [the same skill source](skill/minder-publish/SKILL.md)
  162. and the CLI.
  163. Claude Code invokes it as `/minder:publish`; Codex uses `$minder-publish`. The
  164. portable skill archive retains the `minder-publish` name; the installer applies the
  165. Claude Code namespace without copying a second set of instructions.
  166. For optional local MCP, use the source distribution. With a Python version supported by the MCP extra, install
  167. `python -m pip install ".[mcp]"` and configure the harness to launch
  168. `minder-publish-mcp` using the same private instance configuration. It uses stdio by
  169. default. Remote MCP is disabled by default; enabling it is a separate operator choice.
  170. Remote MCP supports owner-authorized OAuth connections as well as scoped device
  171. Bearer credentials. Its tools do not read server filesystem paths. For binary files
  172. or a complete site, a browser upload request lets the owner select, review and
  173. publish the actual file; the assistant retrieves the confirmed link. Optional host
  174. file inputs require an operator-approved source host. See [connection configuration](docs/SELF_HOSTING.md#connect-an-ai-tool)
  175. for setup and provider-specific limitations.
  176. ## Development and contracts
  177. The full Python distribution contains `server/`, `client/` and `mcp/` under
  178. [`src/minder_publish/`](src/minder_publish/). Browser resources and translations are
  179. packaged with the server. The [architecture](docs/ARCHITECTURE.md) describes component and data flows.
  180. The [packaged defaults](src/minder_publish/defaults.json) own configuration values;
  181. [security acceptance](docs/SECURITY.md#release-acceptance) defines release checks.
  182. Legacy import and API compatibility are maintained within the same distribution
  183. and verified against synthetic fixtures.
  184. See [CONTRIBUTING.md](CONTRIBUTING.md) for development, tests and clean wheel checks.
  185. Application code is [MIT](LICENSE); bundled fonts retain their adjacent OFL notices.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.