talkyard-prod-one  by debiki

Docker-based installer for Talkyard forum/commenting platform

created 9 years ago
268 stars

Top 96.5% on sourcepulse

GitHubView on GitHub
Project Summary

This repository provides a Docker-based, single-server installation for Talkyard, a self-hosted discussion platform. It targets users familiar with Linux, Bash, and Git who need to deploy and manage their own instance, offering automatic upgrades and HTTPS.

How It Works

The installation leverages Docker Compose to manage multiple services, including the main application, a PostgreSQL database, and potentially Elasticsearch for full-text search. Scripts automate OS preparation, Docker installation, firewall setup, and configuration of essential parameters like database passwords and security settings. Automatic HTTPS is handled via Let's Encrypt.

Quick Start & Requirements

  • Install: Clone the repository (git clone https://github.com/debiki/talkyard-prod-one.git talkyard) and execute ./scripts/upgrade-if-needed.sh.
  • Prerequisites: Debian 11 or 12, at least 2 GB RAM, Git, and basic Linux/Bash/Docker knowledge.
  • Setup: Requires provisioning a VPS, pointing a domain name, and configuring email services.
  • Docs: Troubleshooting

Highlighted Details

  • Supports hosting multiple sites from a single installation.
  • Automatic upgrades and HTTPS certificate management.
  • Includes scripts for scheduling log rotation, daily backups, and automatic upgrades.
  • Offers optional OpenAuth login (Google, Facebook, Twitter, GitHub) with instructions available upon request.

Maintenance & Community

  • Beta software with potential bugs.
  • Forum for questions and problem reporting: talkyard.io/forum
  • Users are encouraged to email hello@talkyard.io for security updates and manual upgrade notifications.

Licensing & Compatibility

  • MIT License for the instructions and scripts in this repository.
  • The Talkyard source code itself is not covered by this MIT license.

Limitations & Caveats

  • Classified as beta software, implying potential bugs and instability.
  • Direct access to database and log files on the server is a current security concern, with plans to address this in v1 (2025).
  • OpenAuth login instructions are not fully detailed in the README.
Health Check
Last commit

2 weeks ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
0
Star History
6 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.