@arthas-chat/create-arthas
v1.0.0
Published
Create a self-hosted Arthas E2EE chat instance with one command
Maintainers
Readme
create-arthas
Self-host Arthas E2EE chat with one command.
npx create-arthasWhat It Does
Generates a ready-to-run Docker deployment for your own Arthas instance:
./arthas/
├── docker-compose.yml # Container orchestration
├── .env # Configuration (domain, port, version)
└── Caddyfile # HTTPS reverse proxy (if enabled)Then optionally starts the containers immediately.
Usage
Interactive Mode (default)
npx create-arthasPrompts for:
- Domain name (or
localhostfor local testing) - Port number (default: 8080)
- HTTPS with auto Let's Encrypt (if domain is not localhost)
- Email for certificate notifications
- Docker image version
- Whether to start containers immediately
Non-Interactive Mode
npx create-arthas --defaultsUses localhost:8080, no HTTPS, starts immediately.
Requirements
- Node.js 18+
- Docker & Docker Compose
Examples
Local Development
npx create-arthas --defaults
# → Arthas running at http://localhost:8080
# → WebSocket: ws://localhost:8080/wsProduction with HTTPS
npx create-arthas
# Domain: chat.example.com
# HTTPS: Yes
# Email: [email protected]
# → Arthas running at https://chat.example.com
# → Auto Let's Encrypt certificateAfter Setup
cd arthas
# View logs
docker compose logs -f
# Stop
docker compose down
# Update to latest version
docker compose pull && docker compose up -d
# Reconfigure
npx create-arthas # re-run, overwrites existing filesLicense
MIT
