All apps · 0 apps
Portabase-Dashboard
OfficialDocker app from Portabase's Repository
Overview
Readme
View on GitHub
Portabase
Portabase is a tool designed to simplify the backup and restoration of your database instances. It integrates seamlessly with Portabase agents for managing operations securely and efficiently.
Website • Documentation • Demo • Installation • Report Bug • Request Feature
Installation
You have 5 ways to install Portabase:
- Automated CLI (recommended) - details
- Docker Run - details
- Docker Compose setup - details
- Unraid Community Apps - details - unraid support thread
- Kubernetes with Helm - details
- Development setup - details
Ensure Docker is installed on your machine before getting started.
Supported databases
| Engine | Support | Supported Versions | Restore |
|---|---|---|---|
| PostgreSQL | ✅ Stable | 12, 13, 14, 15, 16, 17 and 18 | Yes |
| MySQL | ✅ Stable | 5.7, 8 and 9 | Yes |
| MariaDB | ✅ Stable | 10 and 11 | Yes |
| MongoDB | ✅ Stable | 4, 5, 6, 7 and 8 | Yes |
| SQLite | ✅ Stable | 3.x | Yes |
| Redis | ✅ Stable | 2.8+ | No |
| Valkey | ✅ Stable | 7.2+ | No |
| Firebird | ✅ Stable | 3.0, 4.0, 5.0 | Yes |
| MSSQL Server | ✅ Stable | 2017, 2019, 2022, Azure SQL | Yes |
| Docker Volume | ✅ Stable | Docker Engine 20.10+ | Yes |
See the Database Servers documentation for version-specific backup and restore details.
Contributing
Want to contribute? See CONTRIBUTING.md for guidelines.
Contributors
License
Distributed under the Apache License. See LICENSE.txt for more details.
Install Portabase-Dashboard on Unraid in a few clicks.
Find Portabase-Dashboard in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.
Requirements
Categories
Download Statistics
Total Downloads Over Time
Related apps
Explore more like this
Explore allLinks
Details
portabase/portabase:latestRuntime arguments
- Web UI
http://[IP]:[PORT:80]- Network
bridge- Shell
sh- Privileged
- false
Template configuration
Host port for the Portabase web interface
- Target
- 80
- Default
- 8887
- Value
- 8887
- Target
- /data
- Default
- /mnt/user/appdata/portabase/dashboard
- Value
- /mnt/user/appdata/portabase/dashboard
enter in the format of postgresql://{Username}:{Secret}@{hostname or ip}:{port}/{Database Name}?schema=public i.e. postgresql://username:password@hostname:1234/portabase?schema=public
- Target
- DATABASE_URL
true/false set to true to enable new user registration from the login page. Required for initial setup if not passing a user via Default User Name, Default User, and Default Password
- Target
- AUTH_SIGNUP_ENABLED
true/false Allow Passkey authentication
- Target
- AUTH_PASSKEY_ENABLED
- Default
- true
- Value
- true
URL of your Portabase dashboard as reachable from your agents i.e. http://portabase.local or https://portabase.myfancydomain.com
- Target
- PROJECT_URL
Secret for your Portabase installation. Must be a hex token i.e. openssl rand -hex 32
- Target
- PROJECT_SECRET
Default User Name (i.e. first {space} last, or nickname)
- Target
- AUTH_DEFAULT_USER_NAME
Default User Email Address
- Target
- AUTH_DEFAULT_USER
Default Password
- Target
- AUTH_DEFAULT_PASSWORD
- Target
- PROJECT_NAME
Schedule for automatic deletion of backups according to the retention policies.
- Target
- RETENTION_CRON
- Default
- 0 0 * * *
SMTP server address (e.g. smtp.resend.com)
- Target
- SMTP_HOST
SMTP server port (e.g. 587)
- Target
- SMTP_PORT
SMTP username
- Target
- SMTP_USER
SMTP password
- Target
- SMTP_PASSWORD
From email address (e.g. no-reply@your-domain.com)
- Target
- SMTP_FROM
Enable SMTP TLS/SSL (true/false)
- Target
- SMTP_SECURE
- Default
- false
- Value
- false