Kendis Enterprise Self-Hosted (Docker, OpenShift) includes an internal MongoDB database by default.
However, if you want to use an external MongoDB database, follow the steps below.
Database Version
Kendis supports MongoDB v 7.0 and higher
Configuration Steps
1. Connect Kendis to the External MongoDB
Open the System Admin area by navigating to:
<yourKendisURL>/system
Remember to change the default Credentials
Username: sysadminPassword: admin
Click on Database Settings in the left navigation.
Fill in the form with the required details:
You must use the Host/URL for MongoDB in this format
mongodb://<user>:<password>@<host>/<db>
Example: If your host IP is 123.122.121.1, the URL would be
mongodb://<user>:<password>@123.122.121.1/<db>
If your MongoDB server uses a hostname, replace the IP address with the hostname.
Enter the values in the Port, Username and Password
Once the connection is successful, proceed to restore your backup to the external MongoDB database.
2. Backup Your Current Internal MongoDB
You can back up your internal MongoDB using either Docker commands or the System Admin UI.
2.1 Backup via Docker
On the server where Kendis Docker is installed, open a command prompt.
Find your Kendis Docker container ID:
> docker ps
Enter the Docker container:
> docker exec -it <container-id> /bin/bash
Inside the container, run the backup command:
> /opt/backup.sh
2.2 Backup via System Admin UI
Go to:
<yourKendisURL>/system
Navigate to the Backup section.
Click Backup Now (top right corner) to take a backup.
Backups are stored in the folder:
/var/lib/kendis-backup
The backup will be stored in the folder "/var/lib/kendis-backup", ensure a new file with the current timestamp has been created there.
Confirm that a new backup file with the current timestamp has been created.
3. Restore Data into External MongoDB
Copy the latest backup file from the server where Docker is running (the backup folder is typically named kendis-backup).
Use the following command to restore the latest backup
mongorestore --drop --gzip --archive=<backup-file-name>.tar.gz
After restoration is complete, refresh your browser.
You should see the login page and can log in with your existing credentials.
Note for OpenShift Deployments
If you are running OpenShift with multiple Pods, you must configure the external database option described above to ensure that all Pods share the same database.