Skip to content

chore: update docker-compose.yml and docs RSSHub config#617

Merged
TonyRL merged 1 commit intoHenryQW:mainfrom
uwuceo:main
Mar 7, 2026
Merged

chore: update docker-compose.yml and docs RSSHub config#617
TonyRL merged 1 commit intoHenryQW:mainfrom
uwuceo:main

Conversation

@uwuceo
Copy link
Contributor

@uwuceo uwuceo commented Mar 7, 2026

chore: update RSSHub port in Docker Compose examples to 1200 and add the public_access network so RSSHub can access websites

Summary by CodeRabbit

  • Documentation
    • Updated RSSHub service examples to reflect the correct port configuration (1200) in setup documentation.
    • Enhanced configuration file annotations with additional service configuration notes and references.

@coderabbitai
Copy link

coderabbitai bot commented Mar 7, 2026

📝 Walkthrough

Walkthrough

These changes update RSSHub port references from 3000 to 1200 in documentation files and add clarifying comments to the Docker configuration. No functional logic is altered; modifications are documentation and configuration annotations only.

Changes

Cohort / File(s) Summary
Docker Configuration Comments
docker-compose.yml
Added commented notes about port configuration (ALLOW_PORTS=1200) and RSSHub image variants. Updated commented port reference from 3000 to 1200.
Documentation Updates
docs/index.md, docs/zh/index.md
Updated RSSHub internal URL examples, changing service port from 3000 to 1200 in both English and Chinese documentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A port shift from three-thousand to twelve hundred bright,
Documentation dances in the morning light,
Comments bloom like clover in the Docker spring,
Simple updates make the systems sing!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title accurately describes the main changes across the PR: updates to docker-compose.yml and documentation files regarding RSSHub configuration (specifically port changes from 3000 to 1200).

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

@greptile-apps
Copy link

greptile-apps bot commented Mar 7, 2026

Greptile Summary

This PR corrects the commented-out RSSHub example configuration in the Docker Compose file and updates documentation to match.

Changes:

  • Port correction: Updates RSSHub's exposed port from 3000 to 1200, matching its actual default. Reflected in docker-compose.yml and both English and Chinese documentation examples.
  • Network access: Adds public_access network to the RSSHub service, enabling outbound internet access (the previous service_only network is internal-only, which would have silently broken feed fetching).
  • ALLOW_PORTS hint: Adds a commented environment variable ALLOW_PORTS=1200 to the TTRSS service, since TTRSS restricts port access by default (allowing only 80/443) and needs this configuration to reach port 1200.
  • Image tag note: Adds a comment about the :chromium-bundled image variant for routes that require Puppeteer.

All changes are to a commented-out example, so no running services are affected. Documentation updates are consistent across both languages.

Confidence Score: 5/5

  • Safe to merge — all changes are correct bug fixes to a commented-out example configuration with consistent documentation updates.
  • All four claimed fixes are verified as accurate: (1) RSSHub's default port is indeed 1200; (2) adding public_access network enables outbound internet access as needed; (3) ALLOW_PORTS=1200 is correct guidance for TTRSS port restrictions; (4) the image tag comment is helpful and accurate. Since the entire rsshub service block remains commented out, no running services are affected. Both English and Chinese documentation are updated consistently.
  • No files require special attention.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    subgraph public_access["public_access network (external access)"]
        TTRSS["service.ttrss<br/>(port 181→80)"]
        Mercury["service.mercury"]
        RSSHub["service.rsshub<br/>(expose: 1200) ✅"]
    end

    subgraph service_only["service_only network (internal: true)"]
        TTRSS2["service.ttrss"]
        Mercury2["service.mercury"]
    end

    subgraph database_only["database_only network (internal: true)"]
        TTRSS3["service.ttrss"]
        DB["database.postgres"]
    end

    Internet((Internet)) -->|fetch RSS feeds| RSSHub
    User((User)) -->|UI| TTRSS

    TTRSS -->|"http://service.rsshub:1200<br/>(ALLOW_PORTS=1200 needed)"| RSSHub
    TTRSS3 --- DB
Loading

Last reviewed commit: 4f906bf

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docker-compose.yml (1)

83-83: Consider removing public_access from RSSHub if external access is not required.

The commented RSSHub configuration includes the public_access network, but since TTRSS communicates with RSSHub via service.rsshub:1200 on the internal Docker network, only the service_only network is necessary. The public_access network is intended for external access (e.g., TTRSS UI), which RSSHub doesn't need unless you plan to expose it externally. Removing it would keep the configuration minimal and focused.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docker-compose.yml` at line 83, Remove the unnecessary public_access network
entry from the RSSHub service definition in docker-compose.yml: update the
RSSHub service (referenced as RSSHub / service.rsshub:1200) to only use the
service_only network by deleting the commented or active "- public_access" line
so RSSHub is not bound to the external network unless you intentionally need
external exposure.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docker-compose.yml`:
- Line 83: Remove the unnecessary public_access network entry from the RSSHub
service definition in docker-compose.yml: update the RSSHub service (referenced
as RSSHub / service.rsshub:1200) to only use the service_only network by
deleting the commented or active "- public_access" line so RSSHub is not bound
to the external network unless you intentionally need external exposure.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5ee293b5-7b3a-4df8-bd93-f8701809564a

📥 Commits

Reviewing files that changed from the base of the PR and between f3bdd44 and 4f906bf.

📒 Files selected for processing (3)
  • docker-compose.yml
  • docs/index.md
  • docs/zh/index.md

@uwuceo uwuceo changed the title Update docker-compose.yml and docs with working RSSHub config chore: update docker-compose.yml and docs RSSHub config Mar 7, 2026
@TonyRL TonyRL merged commit 148660c into HenryQW:main Mar 7, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants