Version: 0.8.0
Branch: production (stable alpha releases)
For: Experienced developers who want to dive in fast
Time: 2-5 minutes (assumes everything works)
📍 Branch Info: This quickstart uses the
productionbranch, which receives stable alpha releases. Themainbranch is for active development and may have bugs.
⚠️ If you hit issues, see ALPHA_TESTING_GUIDE.md for comprehensive troubleshooting.
# 1. Clone and setup (using production branch for alpha testing)
git clone -b production https://github.com/mediajunkie/piper-morgan-product.git
cd piper-morgan-product
python3.12 -m venv venv && source venv/bin/activate
# Requires Python 3.11 or 3.12 - verify with: python --version
pip install -r requirements.txt
# 2. Configure environment variables (CRITICAL - 1 min)
cp .env.example .env
# Edit .env and set JWT_SECRET_KEY:
# Generate a secure key: openssl rand -hex 32
# Add to .env: JWT_SECRET_KEY=your-generated-key-here
# Note: .env is gitignored and survives git pull operations
# 3. Run interactive setup (5 mins)
python main.py setup
# → Follow prompts for:
# - Username and email
# - Secure password (min 8 chars, bcrypt-hashed)
# - API keys (OpenAI/Anthropic)
# 4. Configure preferences (2 mins)
python main.py preferences
# → Answer 5 questions about your work style
# 5. Verify (30 secs)
python main.py status
# → Should show ✓ all green
# 6. Run
python main.py
# → Opens http://localhost:8001
# In Piper's chat interface:
"Hello, what can you help me with?"
"Add a todo: Test Piper Morgan"
"What tasks do I have?"
"Upload a document and summarize it"
After logging in to http://localhost:8001:
docker --version # Should show version
docker ps # Should show containers
# If not: Start Docker Desktop
lsof -i :8001 # See what's using it
kill -9 [PID] # Kill it
python main.py setup # Re-run setup
python main.py status # Verify keys
# Forgot password? Re-run setup to create new account
python main.py setup
# Can't access http://localhost:8001?
# Check server is running: python main.py
# Try: http://127.0.0.1:8001
# Fixed Nov 23, 2025 (Issue #379)
# Make sure you're on latest commit:
git pull origin main # or production branch
# Refresh browser page
# Files UI built Nov 23, 2025 (Issue #379)
# Update to latest:
git pull origin main
# Restart server: python main.py
# Fixed Nov 23, 2025 (Issue #379-14)
# Update to latest commit
# Logout now in user menu (top right)
# Your .env file is gitignored and NEVER deleted by git operations
# If you see JWT_SECRET_KEY warnings after pulling new code:
# 1. Verify .env exists:
ls -la .env
# 2. If missing, CREATE it (this is required for all setups):
cp .env.example .env
# Edit .env in your IDE or text editor and add:
# JWT_SECRET_KEY=<paste-generated-key-here>
# Generate the key:
openssl rand -hex 32
# 3. Restart server:
python main.py
# Note: .env survives git pull, checkout, merge - git never touches it
# If you never created .env, that's the issue - Step 2 above is mandatory
# The setup wizard stores API keys separately (in secure keyring)
python main.py setup # Interactive setup wizard
python main.py preferences # Configure your preferences
python main.py status # System health check
python main.py --verbose # Show detailed logs
python main.py --no-browser # Don't auto-open browser
After python main.py starts the server at http://localhost:8001:
âś… Setup wizard with secure password setup, preferences, health checks âś… Multi-user support, JWT auth with bcrypt, API keys âś… Database (PostgreSQL via Docker) with UUID-based user IDs âś… Token blacklist with CASCADE delete (Issue #291) âś… File upload and document processing (PDF, DOCX, TXT, MD, JSON) âś… Knowledge graph, boundary enforcement âś… Audit logging, test coverage 100%
âś… User Interface (Nov 22-23, 2025):
âś… SEC-RBAC Phase 1 (Nov 21, 2025):
See ALPHA_KNOWN_ISSUES.md for complete status.
This is alpha software (0.8.0). Expect bugs. Don’t use for production. You’re responsible for API costs. See ALPHA_AGREEMENT.md for details.
Happy testing! 🚀
Last Updated: November 23, 2025