Complete guide for using the 1Panel Open Source App to manage your 1Panel servers.
- Getting Started
- First Launch
- Adding a Server
- Dashboard Overview
- Managing Containers
- File Management
- Database Management
- Website Management
- System Settings
- Troubleshooting
1Panel Open Source App is a Flutter-based mobile and desktop client for managing 1Panel servers. It provides a modern, intuitive interface for:
- Monitoring server status and resources
- Managing Docker containers and images
- Browsing and editing files
- Managing databases (MySQL, PostgreSQL, Redis)
- Managing websites and SSL certificates
- Viewing system logs
Mobile:
- Android 6.0+ (API 23+)
- iOS 12.0+
Desktop:
- Windows 10+
- macOS 10.14+
- Linux (Ubuntu 18.04+, Fedora 30+)
Web:
- Modern browsers (Chrome, Firefox, Safari, Edge)
When you first open the app, you'll see the welcome screen:
- Welcome: Introduction to the app features
- Server Setup: Add your first 1Panel server
- Get Started: Begin managing your server
Before adding a server, ensure:
- Your 1Panel server is running and accessible
- You have the API key from your 1Panel panel
- Your device can connect to the server network
-
Tap "Add Server" on the main screen
-
Enter Server Information:
- Name: A friendly name for this server (e.g., "Production Server")
- Address: Server URL (e.g.,
https://panel.example.comorhttp://192.168.1.100:8080) - API Key: Your 1Panel API key (found in 1Panel Panel Settings → API Interface)
-
Test Connection: Tap "Test Connection" to verify
-
Save: Tap "Save" to add the server
- Log in to your 1Panel web interface via a browser.
- Go to Panel Settings (面板设置) -> API Interface (API 接口) on the left sidebar.
- Toggle the API Interface switch to Enable (开启).
- Copy the generated API Key.
- CRITICAL STEP: Add allowed IPs to the IP Whitelist. If you are using the app on a mobile network where your IP frequently changes, enter
0.0.0.0/0to allow all IPs. Otherwise, enter your static IP or VPN IP.
- Use HTTPS: Always use HTTPS in production.
- IP Whitelist: Restrict API access to specific IPs when possible. If using
0.0.0.0/0, ensure your API key is kept strictly confidential. - API Key: Keep your API key secure and rotate it regularly.
- Network: Use VPN for remote server access when possible.
The dashboard provides a quick overview of your server's status:
- System Status: CPU, Memory, Disk usage
- Container Status: Running/stopped containers count
- Website Status: Active websites count
- Database Status: Database services status
- Containers: Jump to container management
- Files: Open file manager
- Databases: Access database management
- Websites: Manage websites
- Logs: View system logs
The dashboard updates in real-time showing:
- CPU usage percentage
- Memory usage (used/total)
- Disk usage (used/total)
- Network I/O statistics
View all Docker containers with:
- Status indicator: Green (running), Red (stopped)
- Name: Container name
- Image: Docker image
- Ports: Exposed ports
- Uptime: How long the container has been running
Tap any container to:
- View Details: Inspect container configuration
- View Logs: Stream container logs in real-time
- Start/Stop: Control container state
- Restart: Restart the container
- Delete: Remove the container
The log viewer provides:
- Real-time log streaming
- Search functionality
- Log level filtering
- Copy and share logs
- Auto-scroll toggle
- Tap the + button in the Containers tab
- Select an image from the list or enter custom image name
- Configure container options:
- Container name
- Port mappings
- Volume mounts
- Environment variables
- Tap Create to start the container
Navigate your server's filesystem with:
- Breadcrumb navigation: Quick folder jumping
- File listing: Name, size, modification date
- Quick actions: Tap and hold for context menu
- Open: View file contents (text files)
- Download: Save files to your device
- Upload: Send files to the server
- Rename: Change file/folder names
- Delete: Remove files/folders
- Create: New file or folder
- Permissions: View and edit file permissions
Built-in text editor for configuration files:
- Syntax highlighting for common formats
- Line numbers
- Search and replace
- Auto-save
- Share/export files
- Text files: .txt, .md, .json, .yaml, .xml
- Code files: .py, .js, .html, .css, .dart, etc.
- Config files: .conf, .ini, .env
- Logs: .log files with special formatting
- MySQL/MariaDB: Full management support
- PostgreSQL: Connection and query support
- Redis: Key-value operations
- Select Database Type: Choose from MySQL, PostgreSQL, or Redis
- Connection: App automatically connects using 1Panel configuration
- Browse: View databases, tables, and data
- Query: Execute SQL queries (MySQL/PostgreSQL)
- Manage: Create, backup, and restore databases
- Database list and management
- Table structure viewing
- Data browsing with pagination
- SQL query execution
- User management
- Backup and restore
- Key browsing and search
- Value viewing (string, hash, list, set, zset)
- Key expiration management
- Redis CLI interface
- Memory usage statistics
View all configured websites:
- Domain: Primary domain name
- Status: Running/stopped indicator
- SSL: Certificate status
- Type: Static, PHP, Reverse Proxy, etc.
- View Details: Configuration and statistics
- Start/Stop: Control website availability
- Configure: Edit website settings
- SSL: Manage certificates
- Delete: Remove website configuration
- View Certificates: List all SSL certificates
- Renew: Manual certificate renewal
- Auto-renewal: Enable automatic renewal
- Let's Encrypt: Issue free certificates
- Custom: Upload your own certificates
Customize the app behavior:
- Theme: Light, Dark, or System default
- Language: English, Chinese, or System default
- Notifications: Enable/disable push notifications
- Auto-refresh: Dashboard refresh interval
- Cache: Clear app cache
Manage your server connections:
- Edit Server: Update server details
- Test Connection: Verify server connectivity
- Delete Server: Remove server from app
- Default Server: Set primary server
- Biometric Lock: Fingerprint/Face ID protection
- PIN Code: App access PIN
- Auto-lock: Lock app after inactivity
- Hide Sensitive Data: Mask API keys and passwords
Problem: Cannot connect to server
Solutions:
- Verify server URL is correct
- Check API key is valid
- Ensure IP whitelist includes your device
- Test network connectivity (ping server)
- Verify HTTPS certificate if using SSL
Problem: "API key error" or "Unauthorized"
Solutions:
- Regenerate API key in 1Panel settings
- Update IP whitelist
- Check system time is synchronized
- Verify API interface is enabled
Problem: App is slow or unresponsive
Solutions:
- Check network connection quality
- Reduce dashboard refresh frequency
- Clear app cache
- Restart the app
- Update to latest version
Problem: Dashboard shows stale data
Solutions:
- Pull down to refresh
- Check server connectivity
- Verify API permissions
- Restart the app
| Code | Meaning | Solution |
|---|---|---|
| 401 | Unauthorized | Check API key and IP whitelist |
| 403 | Forbidden | Verify API permissions |
| 404 | Not Found | Check server URL |
| 500 | Server Error | Check 1Panel server logs |
| 503 | Service Unavailable | 1Panel service may be down |
- Use strong, unique API keys
- Enable IP whitelisting
- Use HTTPS for all connections
- Enable app lock (biometric or PIN)
- Regularly rotate API keys
- Use local network when possible
- Limit concurrent connections
- Close unused server connections
- Regularly clear app cache
- Use descriptive server names
- Group related containers with labels
- Document custom configurations
- Regular backups of important data
- Tap ? icon in any screen for context-sensitive help
- Check tooltips on settings and options
- Documentation: GitHub Docs
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Join our community forums
- Follow us on social media
- Contribute to the project
| Shortcut | Action |
|---|---|
Ctrl/Cmd + R |
Refresh current view |
Ctrl/Cmd + F |
Search |
Ctrl/Cmd + N |
Add new server |
Ctrl/Cmd + , |
Open settings |
Esc |
Go back/Close modal |
Last updated: 2026-03-30