macaw

domain registration backend

Initial Requirements

• works with OpenSRS API
• cache in a database
• handle multiple customers
• compatible with Authelia
• write server in Rust with sea-orm
• maintain audit journal of all domain changes
• handle billing
• contact information updates
• clean interface, no ads

Eventually I'd like to implement most of these features.

Installation

Using Shell Installer

curl --proto '=https' --tlsv1.2 -LsSf \
  https://github.com/fini-net/macaw/releases/latest/download/macaw-installer.sh | sh

Download Pre-built Binaries

From releases page:

• macOS (Apple Silicon): macaw-*-aarch64-apple-darwin.tar.gz
• macOS (Intel): macaw-*-x86_64-apple-darwin.tar.gz
• Linux (GNU): macaw-*-x86_64-unknown-linux-gnu.tar.gz
• Linux (musl): macaw-*-x86_64-unknown-linux-musl.tar.gz

tar xzf macaw-*.tar.gz
mv macaw ~/.local/bin/

Quick Start

Prerequisites

• Rust 2024 edition
• 1Password CLI
• fnox: cargo install fnox
• just command runner
• Access to "fini-opensrs" item in 1Password

Setup

1. Clone and enter directory
2. Sign in to 1Password: just op_signin
3. Verify credentials: just fnox_test
4. Run application: just run_with_creds

Commands

• just list - Show all commands
• just check - Run quality checks (fmt, clippy, test, audit)
• just run_with_creds - Run with OpenSRS credentials
• just test_with_creds - Run tests with credentials

Contributing

• Code of Conduct
• Contributing Guide includes a step-by-step guide to our development process.

Support & Security

• Getting Support
• Security Policy