📝 Point README at central documentation and fix the nginx proxy template - #908
Merged
Conversation
The /api/ proxy did not set proxy_http_version 1.1 or the Upgrade and Connection headers, so WebSocket connections through it could not upgrade. It also inherited nginx's 1 MB client_max_body_size while the API accepts 10 MB, so larger uploads were rejected before reaching it. The read timeout is raised as well: the default 60s is only 6s above the server's ping period, which drops idle connections.
Without one, the build context included node_modules, dist, coverage and any local .env, which slowed builds and could bake a developer's API URL into an image.
Installation, configuration and deployment are now documented centrally for all three repositories, so the README keeps only what is specific to this one. Also corrects instructions that no longer matched the repository: it asked for yarn although there is no yarn.lock and CI uses npm, stated no Node version despite .nvmrc and engines pinning 24, and did not mention that TICKER_API_URL has to include the /v1 suffix.
Adds CLAUDE.md as a symlink to AGENTS.md so agents find the same file under either name, and adopts the commit and pull request section now shared by all three repositories. Also corrects drifted references: eslint.config.js was named as .eslintrc.cjs, release.yml as release.yaml, two release workflows were missing, and the pinned dependency versions had all moved on.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Reduces the README to a pointer at the central documentation site, fixes two defects in the nginx
proxy template, and aligns the agent instructions with the other Ticker repositories.
Why
Documentation for the three Ticker repositories is being consolidated into
systemli/ticker, published at
https://systemli.github.io/ticker/. Installation, configuration, deployment and troubleshooting
concern the stack as a whole and were previously documented nowhere for this repository — the README
had no Docker or deployment section at all, despite an image being published.
The README also carried instructions that no longer matched the repository:
yarn installandyarn run dev, although there is noyarn.lock,packageManagerpins npm and every workflow usesnpm ci;.nvmrcandenginespin 24;TICKER_API_URLmust include the/v1suffix, nor that the value isbuild-time only and the Docker image relies on a runtime proxy instead;
Proxy fixes
docker/nginx.conf.templatehad two defects. Both affect anyone using this repository's owndocker-compose.yml, which mounts the template./api/block set neitherproxy_http_version 1.1nor theUpgradeandConnectionheaders.client_max_body_sizewhile the API itself accepts 10 MB.The read timeout is also raised. The default of 60 seconds sits only 6 seconds above the server's
ping period, which is enough to drop idle connections.
Also included
A
.dockerignore, which the repository lacked — the build context previously includednode_modules,dist,coverageand any local.env, so a local build could bake a developer'sAPI URL into the image.
CLAUDE.mdis added as a symlink toAGENTS.md, andAGENTS.mdadopts the commit and pull requestconventions now shared across the three repositories. Its drifted references are corrected too:
eslint.config.jswas named as.eslintrc.cjs,release.ymlasrelease.yaml, two releaseworkflows were missing, and the pinned dependency versions had all moved on.
Companion pull request: systemli/ticker#470.