Skip to content

Deploy Hetzner demo tracker and document the process #405

@josecelano

Description

@josecelano

Overview

Deploy a real Torrust Tracker demo instance to Hetzner Cloud using the deployer tool and document the entire process end-to-end. The documentation will serve two purposes:

  1. Internal reference: A deployment journal under docs/deployments/hetzner-demo-tracker/ capturing every step, decision, and problem encountered during a real deployment.
  2. Blog post source: The documented process will be adapted into a blog post for the torrust.com blog.

Main domain: torrust-tracker-demo.com (subdomains to be defined during configuration)

Specification

See detailed specification: docs/issues/405-deploy-hetzner-demo-tracker-and-document-process.md

Implementation Plan

Phase 1: Setup and Prerequisites

  • Create docs/deployments/hetzner-demo-tracker/ directory structure
  • Document prerequisites (Hetzner account, API token, SSH keys, tool versions)
  • Verify all required tools are installed and working

Phase 2: Create and Configure Environment

  • Generate environment configuration template for Hetzner
  • Document configuration decisions (server type, location, image, credentials)
  • Create the environment using the deployer

Phase 3: Deploy the Tracker

  • Provision infrastructure (create Hetzner VM)
  • Configure the instance (Docker, SSH, system setup)
  • Release the application (deploy tracker files)
  • Run the services (start the tracker)

Phase 4: Verify and Document

  • Verify tracker is accessible and functioning
  • Verify monitoring stack (Grafana, Prometheus)
  • Take screenshots of running services
  • Document any problems encountered during all phases

Phase 5: Finalize Documentation

  • Write the main deployment journal (README.md)
  • Review and polish all documentation files
  • Update docs/README.md index with new deployments section

Acceptance Criteria

Quality Checks:

  • Pre-commit checks pass: ./scripts/pre-commit.sh

Task-Specific Criteria:

  • A Torrust Tracker demo instance is running on Hetzner Cloud
  • docs/deployments/hetzner-demo-tracker/README.md contains a complete step-by-step walkthrough
  • All problems encountered are documented in problems.md with resolutions
  • Configuration examples are sanitized (no real secrets/tokens)
  • Documentation links to existing user-guide docs where appropriate (no duplication)
  • docs/README.md updated to reference the new deployments section

Related

  • Specification: docs/issues/405-deploy-hetzner-demo-tracker-and-document-process.md

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions