rostr

KO | EN

gitlite — search

#hacktoberfest #ai #llm #golang #android #deep-learning #docker #macos #nodejs #cli #kubernetes #awesome-list #security #mcp

(★ 55)

CLI-first server inventory management with YAML as the single source of truth

rostr 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">rostr</h1>

<p align="center">
  <strong>CLI-first server inventory management with YAML as the single source of truth</strong>
</p>

![Version](https://img.shields.io/badge/version-1.0.0-blue)
![License](https://img.shields.io/badge/license-MIT-green)
![Python](https://img.shields.io/badge/python-3.12+-blue)
![Platform](https://img.shields.io/badge/platform-linux%20%7C%20macos-lightgrey)

rostr is a lightweight, CLI-first server inventory system that uses YAML files as the single source of truth. It automatically generates SSH configs, Ansible inventories, and more from your inventory files.

## Features

- **YAML-based inventory** - Simple, readable, version-controllable
- **SSH config generation** - Auto-generate `~/.ssh/config` entries
- **Ansible inventory** - Dynamic inventory with groups by tag, OS, and notes
- **Fuzzy SSH matching** - `rostr ssh web` matches `web-prod-01`
- **OS auditing** - Detect OS mismatches via parallel SSH
- **Git sync** - Auto-commit and push inventory changes
- **Monitoring setup** - One-command Uptime Kuma + rootless Docker installation
- **Cloud-init automation** - Auto-register servers on boot via webhooks

## Quick Start

```bash
# One-line install (recommended)
curl -fsSL https://raw.githubusercontent.com/wnstify/rostr/main/install.sh | bash
```

<details>
<summary>Alternative installation methods</summary>

```bash
# Install via pipx
pipx install git+https://github.com/wnstify/rostr.git

# Or clone and install manually
git clone https://github.com/wnstify/rostr.git ~/.rostr
cd ~/.rostr
python -m venv venv
source venv/bin/activate
pip install -e .
```

</details>

```bash
# Initialize rostr
rostr init

# Add your first server
rostr add

# Generate configs
rostr sync

# Include in your SSH config
echo "Include ~/.rostr/generated/ssh_config" >> ~/.ssh/config
```

## Usage

```bash
# List servers
rostr list                    # All active servers
rostr list -g production      # Filter by group
rostr list --tag webserver    # Filter by tag
rostr list --all              # Include inactive
rostr list -q                 # Hostnames only (for scripting)

# Server management
rostr add                     # Interactive add
rostr add --hostname web-01 --ip 10.0.1.10 -g production
rostr remove web-01           # Mark as inactive
rostr purge web-01            # Permanent delete
rostr move web-01 staging     # Move to different group

# Information
rostr info web-01             # Server details
rostr search prod             # Search by hostname/IP/notes
rostr groups                  # List all groups
rostr stats                   # Statistics

# Operations
rostr ssh web                 # SSH with fuzzy matching
rostr sync                    # Regenerate all configs
rostr validate                # Check for issues
rostr backup                  # Create timestamped backup

# OS auditing
rostr audit-os                # Compare inventory vs actual
rostr audit-os --fix          # Auto-update inventory

# Dry run (preview changes)
rostr --dry-run add --hostname test --ip 10.0.0.1 -g staging

# Setup wizards (optional features)
rostr setup monitoring          # Install Uptime Kuma + rootless Docker
rostr setup automation          # Configure cloud-init registration
```

## Directory Structure

```
~/.rostr/
├── config.yaml              # Configuration
├── inventory/
│   ├── _defaults.yaml       # Default values
│   └── groups/
│       ├── production.yaml  # Production servers
│       ├── staging.yaml     # Staging servers
│       └── ...
├── generated/               # Auto-generated (don't edit)
│   ├── ssh_config           # SSH config
│   ├── ansible-inventory.yaml
│   └── hosts.txt
├── backups/                 # Timestamped backups
└── logs/                    # Operation logs
```

## Inventory Format

```yaml
# inventory/groups/production.yaml
group:
  name: Production
  code: production
  description: Production servers

servers:
- hostname: web-prod-01
  ip: 10.0.1.10
  os: ubuntu-24.04
  tags:
  - webserver
  - docker
  notes: Primary web server
  created_at: '2026-01-01'
  active: true
```

## Generated Files

### SSH Config

```
# ~/.rostr/generated/ssh_config
Host web-prod-01
    HostName 10.0.1.10
    User admin
```

### Ansible Inventory

Groups are auto-generated by:
- Server group: `production`, `staging`
- Tag: `tag_webserver`, `tag_docker`
- OS: `os_ubuntu_24_04`
- Notes: `notes_primary`

```bash
ansible -i ~/.rostr/generated/ansible-inventory.yaml tag_webserver -m ping
```

## Configuration

See [docs/CONFIGURATION.md](docs/CONFIGURATION.md) for all options.

```yaml
# config.yaml
defaults:
  ssh_user: admin
  ssh_port: 22
  os: ubuntu-22.04

integrations:
  uptime_kuma:
    enabled: false
  git_sync:
    enabled: false
```

## Environment Variables

Secrets must be stored in environment variables:

```bash
# For Uptime Kuma integration
export ROSTR_UPTIMEKUMA_DB_PASS='your-password'

# For registration API
export ROSTR_REGISTRATION_TOKEN='your-token'
```

## Optional Features

During `rostr init`, you'll be prompted to set up optional features:

### Server Monitoring

Install Uptime Kuma with rootless Docker for server monitoring:

```bash
rostr setup monitoring           # Interactive installer
rostr setup monitoring-status    # Check status
rostr setup monitoring-update    # Update to latest
rostr setup monitoring-uninstall # Remove installation
```

See [docs/UPTIME-KUMA.md](docs/UPTIME-KUMA.md) for details.

### Cloud-Init Automation

Automatically register new servers when they boot:

```bash
rostr setup automation           # Configure webhook + API
rostr setup automation-status    # Check status
rostr setup automation-restart   # Restart API service
```

See [docs/CLOUD-INIT.md](docs/CLOUD-INIT.md) for details.

## Documentation

- [Installation](docs/INSTALLATION.md) - Setup methods, dependencies, shell completions
- [Configuration](docs/CONFIGURATION.md) - All config options and environment variables
- [Usage Reference](USAGE.md) - Complete command reference with examples
- [Security](docs/SECURITY.md) - Best practices, secrets management, audit checklist

### Optional Features

- [Uptime Kuma Integration](docs/UPTIME-KUMA.md) - Server monitoring setup
- [Cloud-Init Automation](docs/CLOUD-INIT.md) - Auto-registration on boot
- [Rootless Docker](docs/ROOTLESS-DOCKER.md) - Secure Docker setup

## Requirements

- Python 3.12+
- Linux or macOS (Unix-only)

## About

### Author

**Simon** - Infrastructure engineer and automation enthusiast.

### Webnestify

[Webnestify s.r.o.](https://webnestify.cloud) is a Slovakia-based company providing dedicated hosting, security, performance optimization, and managed services.

> "Access best-in-class dedicated hosting, security, performance, support, and more - all in one nest."

### Related Projects

rostr is part of a larger ecosystem of server management and automation tools:

| Project | Description |
|---------|-------------|
| [server-configs](https://github.com/wnstify/server-configs) | Production-ready cloud-init templates and security hardening |
| [backupd](https://github.com/wnstify/backupd) | Menu-driven backup solution for web apps and databases |
| [docker](https://github.com/wnstify/docker) | Docker project templates for open-source applications |
| [tubeflow](https://github.com/wnstify/tubeflow) | Research-first YouTube content creation system |

See all public projects at [github.com/wnstify](https://github.com/wnstify).

### YouTube

Follow [@webnestify](https://youtube.com/@webnestify) for tutorials on self-hosting, server management, and automation.

## License

MIT License - see [LICENSE](LICENSE)

## Contributing

Issues and discussions are welcome. Pull requests are not accepted at this time - this is a personal project that I maintain for my own infrastructure needs.

rostr

rostr 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

rostr

rostr 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README