Skip to main content
Enterprise Only

This section is only relevant to Enterprise customers who acquired an on-prem license.

Quick Start Guide

Get your Permit Platform up and running in just a few minutes.

What You Need​

⚠️ Important: Complete the prerequisites setup before starting installation.

Quick Checklist​

  • ✅ Linux server (4+ CPU, 8GB+ RAM, 50GB+ storage)
  • ✅ Git repository for policies (GitHub/GitLab/Bitbucket)
  • ✅ SSH key pair for Git access
  • ✅ Root/sudo access

Installation in 3 Steps​

Step 1: Download & Extract​

# Download the package (using your provided link)
curl -L "<your-download-link>" -o permit-platform-v1.0.0.tar.gz

# Extract
tar -xzf permit-platform-v1.0.0.tar.gz && cd permit-platform-v1.0.0

Step 2: Run Installation​

# Interactive installation (recommended)
sudo ./install.sh

# The installer will prompt for:
# - Deployment size (Small/Medium/Large)
# - Git repository URL
# - SSH key path
# - Domain name or IP access

Installation time: 5-10 minutes
What you'll see: Progress updates and status messages

Step 3: Access Platform​

After installation completes, you'll see:

Option 1: Custom Domain (Recommended)

🎉 Installation Complete! (took 7 minutes)

Access: https://permit.yourcompany.com
✅ Platform ready - open in browser

Option 2: Server IP Access

🎉 Installation Complete! (took 7 minutes)

Access: https://<server-ip>
✅ Platform ready - open in browser

Next Steps​

  1. Open the platform in your web browser
  2. Complete the setup wizard - create your organization
  3. Create admin users and configure initial policies
  4. Test the integration with your applications

Quick Commands Reference​

# Check platform status
./scripts/status.sh

# View logs
./scripts/logs.sh --all

# Restart platform
./scripts/restart.sh

# Collect logs for support
./scripts/collect-logs.sh

Need More Control?​

For advanced installation options including multi-server setup, custom configurations, and automated deployment, see the detailed installation guide.

Something Not Working?​

Check the troubleshooting guide for common issues and solutions.

Ready for production? Continue to Management Guide to learn about day-to-day operations.

Contents