Install and manage apps from the Apps menu
The Apps menu is where you install apps and look after the ones you have. This guide covers Browse Apps, Manage Apps and Refresh Cache, and tells you when to use Stack Manager or an alias instead.
Overview
Section titled “Overview”Go to Apps in the main menu. The Apps Menu has three entries you use for apps:
| Entry | What it does |
|---|---|
| Browse Apps | Lists the official apps and installs the one you pick. The line reads “Browse and install from N official apps”. |
| Manage Apps | Lists the apps you installed and lets you start, stop, restart, read logs, remove or reinstall one. The line reads “Manage installed apps (N running, M stopped)”. |
| Refresh Cache | “Sync manifests and rebuild registry”. Reloads the list of apps. |
Core apps such as Traefik are in neither list. They have their own menus.
You need a Basic, Plus or Pro license to install or reinstall an app. Without one you see “License Required” and “Official apps require a paid license.” Start, Stop, Restart, Logs and Remove in Manage Apps have no license or requirements check. See Licenses.
The Apps Menu also lists ShellInABox under SYSTEM APPS. It is not a Docker app, so Manage Apps doesn’t show it. See Parts that don’t run in Docker.
Install an app with Browse Apps
Section titled “Install an app with Browse Apps”- Go to Apps > Browse Apps. The title shows how many apps you can pick, in the form “Browse Apps (N apps)”.
- Find the app in the list. It is sorted by name. Each line has the app name and a short description.
- Select the app and choose Install.
- At “Do you want to install this app?”, choose Yes.
- Answer the questions that follow. See The install questions.
- Look for “APP installation complete!”. If it fails, you see “APP installation failed”. Read the messages above it.
To see an install from start to finish, watch Deployrr 5 walkthrough: install an app at 28:48 (shows Deployrr v5; menus and steps differ in v6).
After the list loads, a marker after the description tells you the state of each app:
| Marker | Meaning |
|---|---|
| [Running] (green) | The app is installed and running. |
| [Installed] (yellow) | The app is installed but not running. |
| No marker | The app is not installed. |
If the list is empty, you see “No apps found in registry.” and “Please check that the apps registry is properly configured.” Try Refresh Cache (see below).
The install questions
Section titled “The install questions”Which questions you see depends on the app. You may see some or all of these:
- Already Installed. This shows when you pick an app that is already installed or running. It says “plex is already running.” or “plex is already installed.” The name is the app’s short name in lowercase. It lists what a reinstall does: stop the existing container, recreate it with the latest image and keep data volumes. Choose Yes to go on or No to cancel. Yes also removes the app’s entry from the Deployrr Dashboard. It is added again at the end of the install. See Reinstall an app and keep its data.
- Port Configuration. “Enter the port for APP”. Deployrr suggests the first free port. If you type a port that is not a number in the allowed range, you see “Invalid Port” and Deployrr uses the suggestion. If your port is taken, you see “Port In Use” and Deployrr uses the suggestion. For a clash you can’t fix, see Port is already in use.
- Password Configuration. Deployrr suggests a password. Keep it or type your own. Leave the box empty to use the suggestion.
- GPU Selection. For apps that can use a GPU. Pick a GPU, or choose the CPU. If you cancel, the app uses the CPU. See GPU hardware transcoding.
- Traefik Subdomain. “Enter a subdomain for APP”. It shows when Traefik is running and the app supports it. Use lowercase letters and no spaces. If you cancel or leave it empty, Deployrr uses the default.
- Pick an Authentication Method. The login for the app. Skip leaves the app with no Traefik login. See Choose a login method for your apps.
- Pick an Exposure Method. Both, Internal or External. You see it only in Advanced mode. Default (Internal) keeps the app on your LAN. In Simple mode there is no prompt, and the app is exposed on both. See Simple vs Advanced Traefik mode.
Change an answer later
Section titled “Change an answer later”You don’t have to reinstall an app to change most answers. This table shows where each answer is saved and the page with the steps.
| Question | Where your answer is saved | To change it later |
|---|---|---|
| Port Configuration | A port setting in your .env file, such as SONARR_PORT. You open the app at http://YOUR_SERVER_IP:PORT. |
Edit the setting and recreate the app. See Change the port of an installed app. If the app is behind Traefik, also change the port in its rules file. |
| Password Configuration | A password setting in your .env file. |
See Edit .env and secrets. Some apps use this password only to create the first login. After that, change it inside the app. |
| GPU Selection | GPU lines in the app’s compose file. | Install the app again over the existing one and pick another GPU or the CPU. This replaces your edits to its compose file. See If the app is already installed. |
| Traefik Subdomain | The app’s Traefik rules file. A few apps use Docker labels instead. | Edit the file. See Change the subdomain of an app you already installed. |
| Pick an Authentication Method | The same rules file or labels. | Use Security > Manage Auth (Pro license), or edit the file. See Change the login method. |
| Pick an Exposure Method | The same rules file or labels. | Use Proxy > Traefik > Manage Exposure (Advanced mode, Plus or Pro license). See Change the exposure. |
A reinstall asks every question again, but it doesn’t always reuse your old answers:
- The app gets a new port. The port box treats the app’s current port as taken, so it suggests the next free one. If you type the current port, you see Port In Use and Deployrr uses the suggestion. After the reinstall, open the app at the new port. If the app is behind Traefik, put the new port in its rules file, as in Change the port of an installed app. To keep the old port instead, change it back in
.envand recreate the app. - The password box suggests a new password. Choosing OK with the suggestion, or leaving the box empty, saves the new one. Type your old password to keep it.
- An existing Traefik rules file stays as it is, so new subdomain, login and exposure answers don’t reach Traefik. See Change login or exposure.
See your installed apps with Manage Apps
Section titled “See your installed apps with Manage Apps”- Go to Apps > Manage Apps.
- Read the list. The title shows the count, for example “Manage Apps (3 installed)”.
If you have no apps, you see “No apps installed.” Use Browse Apps to install one.
Each line shows the app name and a marker in brackets:
| Marker | Meaning |
|---|---|
| [Installed] (yellow) | The app is stopped. |
| [Running] (green) | The app is running, and Deployrr found no Traefik details for it. |
| [Running; EXPOSURE; LOGIN] | The app is running. After the first semicolon you see where it is reachable, then its login. For example, [Running; Int; Authelia]. Either part can be missing. |
For a running app that has a Traefik rules file, the marker can show:
- Exposure: Ext (external only), Int (internal only) or Int & Ext (both).
- Login: Authelia, Authentik, Google OAuth, TinyAuth, Basic Auth or No Auth.
The text above the list gives a colour legend: green is running or secure, yellow is stopped or basic, and red is no auth. Login names are green for the strong methods, yellow for Basic Auth and red for No Auth.
For the same idea in an earlier version, watch Deployrr 5 intro: the Apps menu at 13:00 (shows Deployrr v5; menus and steps differ in v6).
Manage one app
Section titled “Manage one app”- In Manage Apps, select the app and choose Manage.
- In the Manage: APP box, check the status line. It says Running or Stopped.
- Pick an action.
The actions you see depend on the status:
| App status | Actions |
|---|---|
| Running | Logs, Restart, Stop, Remove |
| Stopped | Start, Logs, Remove, Reinstall |
Start, Stop and Restart
Section titled “Start, Stop and Restart”Each one shows a title such as “Starting APP”, then one step, then a result:
| Action | Success message | Failure message |
|---|---|---|
| Start | “APP started successfully” | “Failed to start APP” |
| Stop | “APP stopped successfully” | “Failed to stop APP” |
| Restart | “APP restarted successfully” | “Failed to restart APP” |
On failure you see only that one line. It doesn’t say why. Check the app’s logs with Logs. Or run this in a terminal. Replace NAME with the app’s container name, which is the app’s short name such as plex:
sudo docker logs NAMEWith the Deployrr bash aliases: dlogs NAME. See Bash aliases.
To understand how container logs work, read UDMS part 13: Container logs with Docker commands (manual setup, background only).
Logs shows “Logs: APP” and “Showing last 50 lines (Ctrl+C to exit)”. It then keeps following new lines. Press Ctrl+C once to stop following the log and go back to the menu. Deployrr keeps running. Pressing Ctrl+C twice closes Deployrr.
Remove
Section titled “Remove”Remove takes the app out of your setup. It asks two questions, then prints each step as it goes.
- Choose Remove.
- In the Remove APP box, read “This will remove the APP container”. It asks “Remove app data as well?”:
- No keeps the app’s data in the
appdatafolder, so you can reinstall later. - Yes removes the container and all of the app’s data. If the app was built on your server, it also deletes that built image.
- No keeps the app’s data in the
- In the Confirm Removal box, check “Remove Data: Yes” or “Remove Data: No”. Choose Yes to proceed with the removal, or No to cancel.
- If the app has linked containers, such as a database, the Multicontainer App Removal box asks how to go on. Pick Remove APP only, Remove APP + all dependencies or Cancel removal.
- Wait for the steps to finish. Look for “APP removed successfully”.
The steps stop the container and remove it. They also remove the app’s compose configuration, its Traefik configuration, its Deployrr Dashboard entry, its saved settings and its secrets. The last step, “Cleaning up…”, removes the appdata folder only if you answered Yes to removing app data.
Remove has no backup prompt and doesn’t clean up unused Docker volumes. Stack Manager Delete > Full does clean them up.
If you ever see “Cannot remove dependency directly”, Deployrr names the app to remove instead. Remove that app.
Reinstall
Section titled “Reinstall”Reinstall shows only when the app is stopped. It prints “Reinstalling APP”, runs the install questions again and ends with “APP reinstalled successfully”, or “APP reinstallation failed”. It skips the Already Installed box.
See Reinstall an app and keep its data for what it keeps and resets.
Refresh the app list
Section titled “Refresh the app list”Refresh Cache reloads the list of apps that Browse Apps and Manage Apps show. Use it when:
- An app you expect is missing from Browse Apps.
- You see “No apps found in registry.”
- You see “App Not Found” with the advice to try refreshing the apps cache.
- Go to Apps > Refresh Cache.
- In the Build App Cache box, read “This will sync all app manifests and rebuild the cache”. Choose Yes.
- Watch the sync steps, ending with “Building app registry…”.
- Look for “Registry built (N apps)” and “Cache marker created”.
If you see “Cache build incomplete”, the sync of the apps you can install failed. The sync downloads app files, so check that your server is online, then run it again. Other “sync failed” lines are warnings and don’t stop the build.
The only requirement is the Disclaimers step. If you see a Requirements Not Met box, see Requirements Not Met.
The cache expires after 7 days
Section titled “The cache expires after 7 days”When the cache expires, Prerequisites shows Build Cache as EXPIRED. Installs then show “Prerequisites - All steps must be completed” until you refresh it. Prerequisites > Build Cache does the same thing as Apps > Refresh Cache. Run either one. See Prerequisites.
Which tool to use
Section titled “Which tool to use”| You want to | Use |
|---|---|
| Install an app | Apps > Browse Apps |
| Start, stop or restart one app and see if it worked | Apps > Manage Apps > the app |
| Read the last 50 log lines and follow new ones | Apps > Manage Apps > the app > Logs, or dlogs NAME |
| Start or stop one app by number, or all at once | Tools > Stack Manager > Start Container (lists only apps that are not running) or Stop Container (lists only running apps) |
| Apply a change after you edit an app’s compose file | Tools > Stack Manager > Recreate, or dcrec APP. See Restart, Recreate or Reinstall |
| Restart one app from the terminal | dcrestart APP |
| Remove an app and its container but keep its data | Tools > Stack Manager > Delete > Safe |
| Remove an app and all its data | Manage Apps > Remove with Yes, or Stack Manager > Delete > Full |
| Install an app again with default settings | Reinstall an app and keep its data |
In the aliases, replace APP with the app’s name. See Bash aliases.
Remove and Stack Manager Delete both remove the container, compose file, Traefik rules file, Dashboard entry and saved settings. They differ in what they ask and what they keep:
| Manage Apps > Remove | Stack Manager > Delete | |
|---|---|---|
| You choose | Remove app data: Yes or No | Safe or Full |
| App data | Kept on No, deleted on Yes | Kept on Safe, deleted on Full |
| Secrets | Deleted either way | Kept on Safe, deleted on Full |
| Unused Docker volumes | Not cleaned | Removed on Full |
| Offers a backup first | No | Yes |
| License and Prerequisites check | None | Every Stack Manager option checks for a Basic, Plus or Pro license and finished Prerequisites |
See Stack Manager for every option.
Parts that don’t run in Docker
Section titled “Parts that don’t run in Docker”A few things Deployrr sets up run on the server itself as system services, not as containers. Manage Apps and docker ps don’t list them, and Docker commands and the Deployrr aliases don’t control them.
| Part | Where you set it up | What its menu line shows | Service name | Page |
|---|---|---|---|---|
| ShellInABox | Apps > SYSTEM APPS > ShellInABox | RUNNING, or STOPPED when installed but not running | shellinabox |
Install ShellInABox |
| CrowdSec Firewall Bouncer | Security > Firewall Bouncer | RUNNING while the service runs, otherwise nothing | crowdsec-firewall-bouncer |
Block bad visitors with CrowdSec |
| Rclone mount | System > Mounts > Rclone > Automount | Your mount folder, then mounted or not mounted. Before setup: “SMB Share via Rclone” | rclone-NAME, where NAME is your remote name |
Mount a NAS share with Rclone |
| Delay Media Apps | System > Mounts > Rclone > Delay Media Apps | DONE once set up | start-media-after-boot |
Apps are stopped after a reboot |
Delay Media Apps runs once at boot. It waits up to 15 minutes for the Rclone mount, starts your media apps, and then exits. systemctl status shows it as inactive afterwards. That is normal. If the mount never appears, it stops the media apps instead. To see what happened at the last boot, look in the logs/HOSTNAME folder inside your Docker folder: rclone-NAME-timer.log says when the media apps started, and rclone-NAME-timer.err says when they failed to start.
To check, stop, start or read the log of one of them, use the general Linux commands below. Replace SERVICE with the service name from the table.
sudo systemctl status SERVICEsudo systemctl stop SERVICEsudo systemctl start SERVICEsudo journalctl -u SERVICE -n 50To remove the Rclone mount and Delay Media Apps, use System > Mounts > Rclone > Uninstall. It unmounts the share and removes Rclone and both services. ShellInABox has no remove option in Deployrr. Remove it by hand as in Remove it, including its Traefik rules file and Dashboard entry. Afterwards the Apps Menu still shows ShellInABox as STOPPED.
Next steps
Section titled “Next steps”- Fix an app that shows Running but keeps failing: A container keeps restarting, is unhealthy or has exited.
- Update your apps: Update your apps.
- Open your apps from one page: Deployrr Dashboard.

