@dao-solution/mypit
v1.1.7
Published
MyPit CLI - Manage your MyPit deployment with Docker
Maintainers
Readme
MyPit CLI - Automated Deployment Tool
One-command installation and management of MyPit decentralized application platform
🚀 Quick Install
npm install -g @dao-solution/mypit
mypit installThat's it! The CLI will ask you for credentials and automatically download, extract, and configure all services.
Installation Flow
mypit install
# You'll be prompted for:
# - MinIO Username (default: minioadmin)
# - MinIO Password (minimum 8 characters)
# - PostgreSQL Username (default: postgres)
# - PostgreSQL Password (minimum 8 characters)
# After installation, view your credentials:
mypit credentials --list
# Need to change MinIO credentials?
mypit credentials --reset✨ Features
- 📥 Automatic Download - Fetches deployment files from GitHub
- 🔧 Auto-Configuration - Sets up Docker containers and environment
- 🔐 Credential Customization - Set your own MinIO and database passwords during install
- 🔑 Security - Generates admin keys and JWT tokens automatically
- 💾 Backup & Restore - Easy database backup and recovery
- 🔄 Easy Restart - Reload environment variables without data loss
- 📋 Credential Management - View and reset credentials anytime
- 🎯 Simple Commands - Intuitive CLI interface
📋 Prerequisites
- Node.js 18.0.0 or higher
- Docker Desktop (must be running)
- Ports available: 3000, 3210, 3211, 6791, 5432, 9000, 9001
🎯 Commands
| Command | Description |
|---------|-------------|
| mypit install | Download and install MyPit with custom credentials |
| mypit stop | Stop all services |
| mypit restart | Restart services (picks up .env changes) |
| mypit credentials --list | Display current credentials |
| mypit credentials --reset | Reset MinIO credentials and restart |
| mypit store | Create database backup |
| mypit restore | Restore from backup |
| mypit clean | 🚨 Remove all services and data |
| mypit help | Show help information |
🌐 Access Points
After installation, access your services:
| Service | URL | |---------|-----| | Frontend | http://localhost:3000 | | Admin Dashboard | http://localhost:6791 | | MinIO Console | http://localhost:9000 | | Backend API | http://localhost:3210 |
📁 File Locations
Deployment Files:
- macOS/Linux:
~/.mypit/deployment/ - Windows:
%USERPROFILE%\.mypit\deployment\
Backups:
- All platforms:
~/Downloads/mypit-backup/
📦 What's New
- ✅ Automatic deployment file download from GitHub
- ✅ Cross-platform tar.gz extraction (Windows, macOS, Linux)
- ✅ Custom credential setup during installation
- ✅ Password validation (minimum 8 characters)
- ✅ Credential management commands (list/reset)
- ✅ New
restartcommand to reload environment variables - ✅ Centralized file storage in user profile
- ✅ Complete
~/.mypitfolder cleanup withcleancommand - ✅ Works from any directory
- ✅ Improved error handling and user feedback
- ✅ Warning when reinstalling over existing installation
🔧 Troubleshooting
Docker Not Running
❌ Docker is not installed or not running!Solution: Start Docker Desktop and ensure it's fully initialized.
Password Too Short
❌ Password must be at least 8 characters longSolution: Enter a password with 8 or more characters when prompted.
Download Failed
❌ Failed to download deployment filesSolution:
- Check internet connection
- Verify firewall settings
- Manual download option provided in error message
Port Already in Use
Solution: Ensure no other services are using required ports (3000, 3210, 6791, 9000, 5432, 9001)
Credential Changes Not Working
Solution:
- MinIO credentials: Use
mypit credentials --reset - Database credentials: Require
mypit cleanthenmypit install(data will be lost)
Clean Command Not Removing Files
Solution: The clean command now completely removes ~/.mypit folder. If issues persist, manually delete it.
🤝 Contributing
Contributions are welcome! Please:
- Fork the repository
- Create a feature branch
- Make your changes
- Submit a pull request
📝 License
MIT License - see LICENSE file for details
🔗 Links
- GitHub: https://github.com/dao-solution-inc/packaging
- npm: https://www.npmjs.com/package/@dao-solution/mypit
- Issues: https://github.com/dao-solution-inc/packaging/issues
- Deployment Files: GitHub Repository
📞 Support
For questions, issues, or feature requests:
- Open an issue
- Check existing documentation
- Review troubleshooting guide
🏢 About
MyPit is developed and maintained by DAO Solution Inc.
Made with ❤️ by DAO Solution Inc.
