Skip to content

Add mention of history archive path to readme - #874

Merged
leighmcculloch merged 5 commits into
mainfrom
historyarchiveurl
Jan 8, 2026
Merged

Add mention of history archive path to readme#874
leighmcculloch merged 5 commits into
mainfrom
historyarchiveurl

Conversation

@leighmcculloch

@leighmcculloch leighmcculloch commented Jan 7, 2026

Copy link
Copy Markdown
Member

What

Add a mention to the README for where history archives are accessible in the quickstart image.

Why

The /archive endpoint was never documented, but it is there.

@github-project-automation github-project-automation Bot moved this to Backlog (Not Ready) in DevX Jan 7, 2026
@leighmcculloch
leighmcculloch marked this pull request as ready for review January 7, 2026 04:02
@leighmcculloch
leighmcculloch requested review from a team and Copilot January 7, 2026 04:03

Copilot AI left a comment

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.

Pull request overview

This PR introduces a new /history-archive endpoint with clearer semantics to expose the history archive in local mode, while maintaining the existing /archive endpoint for backwards compatibility. The change addresses the ambiguity of the term "archive" which could refer to different types of archives in the Stellar ecosystem.

  • Adds new /history-archive nginx location that proxies to port 1570 (Python HTTP server serving history archive files)
  • Retains /archive endpoint for backwards compatibility with existing tooling
  • Documents the new endpoint in the README with appropriate local-mode-only notation

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
local/nginx/etc/conf.d/history-archive.conf Adds new /history-archive location block with rewrite rule and proxy configuration; keeps existing /archive location with explanatory comment about backwards compatibility
README.md Adds documentation for the new History Archive endpoint in the HTTP APIs section, noting it's only available with --local flag

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread local/nginx/etc/conf.d/history-archive.conf Outdated
@leighmcculloch leighmcculloch changed the title Expose history archive on /history-archive Add mention of history archive path to readme Jan 8, 2026
@leighmcculloch
leighmcculloch enabled auto-merge (squash) January 8, 2026 05:55
@leighmcculloch
leighmcculloch enabled auto-merge (squash) January 8, 2026 05:55
@leighmcculloch

Copy link
Copy Markdown
Member Author

I've reduced this change down to documenting the current history archive URL. Now that it was pointed out over on this other issue that we shouldn't be referring to the meta as an archive, we don't really need to change this.

@leighmcculloch
leighmcculloch merged commit d08c68f into main Jan 8, 2026
89 checks passed
@leighmcculloch
leighmcculloch deleted the historyarchiveurl branch January 8, 2026 06:47
@github-project-automation github-project-automation Bot moved this from Backlog (Not Ready) to Done in DevX Jan 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants