tux icon indicating copy to clipboard operation
tux copied to clipboard

docs: add self-hosting guide for Tux with Docker and Postgres

Open electron271 opened this issue 10 months ago • 3 comments

Summary by Sourcery

Documentation:

  • Document how to self-host Tux with Docker and Postgres.

electron271 avatar Feb 08 '25 02:02 electron271

Reviewer's Guide by Sourcery

This pull request adds a new self-hosting guide for Tux that details how to deploy using Docker Compose and Postgres. The guide outlines prerequisites, installation steps, and troubleshooting tips.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Addition of the self-hosting guide document.
  • Created a new documentation file that explains how to set up self-hosting for Tux.
  • Outlined prerequisites including Docker, Docker Compose, Postgres database, Discord bot token, and optional Sentry URL.
  • Provided step-by-step installation instructions including repository cloning, environment configuration, starting the bot via Docker Compose, checking logs, pushing the database schema with Prisma, and verifying system functionality.
docs/self-hosting.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an issue from a review comment by replying to it. You can also reply to a review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull request title to generate a title at any time. You can also comment @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in the pull request body to generate a PR summary at any time exactly where you want it. You can also comment @sourcery-ai summary on the pull request to (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the pull request to resolve all Sourcery comments. Useful if you've already addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull request to dismiss all existing Sourcery reviews. Especially useful if you want to start fresh with a new review - don't forget to comment @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

  • Contact our support team for questions or feedback.
  • Visit our documentation for detailed guides and information.
  • Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai[bot] avatar Feb 08 '25 02:02 sourcery-ai[bot]

@kzndotsh needs to be figured out, you said would be added to the pre-0.1 documentation

electron271 avatar Apr 18 '25 01:04 electron271

Deploying tux with  Cloudflare Pages  Cloudflare Pages

Latest commit: d454e92
Status: ✅  Deploy successful!
Preview URL: https://c0eadbe7.tux-afh.pages.dev
Branch Preview URL: https://self-hoster-docs.tux-afh.pages.dev

View logs

This PR has been stale for a month. can we look into either merging or closing it soon?

anemoijereja-eden avatar Jun 20 '25 16:06 anemoijereja-eden

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

github-actions[bot] avatar Jun 23 '25 19:06 github-actions[bot]