Skip to content

Refresh, Reset or Remove Deployrr (Settings menu)

GuideDeployrr v6.0+CurrentInstallDockerBackupsHost system

The Settings menu has three items that clear things out: Refresh, Reset and Remove. This guide shows what each one does, which one you need, and what to do afterwards.

Start with Refresh. It is safe and fixes most odd behaviour. Reset and Remove are last resorts.

Refresh Reset Remove
Menu line Clear Deployrr Cache Reset Deployrr Status Remove Deployrr
Asks you to confirm No Yes (Y) Yes (Y)
Stops your apps No Yes No
Deletes Docker images No Yes No
Deletes saved settings (Docker folder, username, domain, Mode) No No Yes
Deletes setup status (what shows as DONE) No Yes Yes
Deletes the Deployrr program and its logs No Yes Yes
Touches your Docker folder and app data No No No
What you do next Start Deployrr again Run the installer, then redo some Prerequisites Nothing, or clean up by hand
  • Deployrr acts oddly after an update, or a run was cut off. Use Refresh.
  • You want a clean start for Deployrr, and you accept that your apps stop. Use Reset. Try Refresh first.
  • You want Deployrr gone but your apps to keep running. Use Remove.
  • You want to update Deployrr. None of these. See Updating Deployrr.
  • You want to refresh the list of apps. That is a different command. See Apps > Refresh Cache.

The Settings menu is titled Deployrr Settings. You do not need a license to open it or to use Refresh, Reset or Remove. It holds these items:

  • Intro: turns the intro messages on the main menu on or off.
  • Mode: switches between NORMAL and EXPERT. See EXPERT mode.
  • Version Pins: edits Docker image version pins. It needs a Pro license.
  • Status: shows the Deployrr status.
  • Logs: makes a sanitized log you can share. Type Y and press Enter to start. The log is saved in the folder you ran Deployrr from, and the screen ends with “Sanitized log ready for sharing”. Read the log before you share it.
  • Refresh, Reset and Remove: covered below.

To see these three items on screen, watch Deployrr 5 walkthrough: Settings menu at 1:24:19 (shows Deployrr v5; menus and steps differ in v6). It says Reset leaves your Docker apps alone. In v6, Reset stops your apps, so follow this page for Reset.

Refresh clears a cached copy of Deployrr’s own files. Deployrr gets a fresh copy the next time it starts. Refresh does not touch your apps, settings or status.

  1. Open Settings.
  2. Select Refresh.

There is no confirmation. You see 1/1 Clearing Deployrr cache, then Cache cleared, then:

Refresh complete. Please re-run Deployrr to continue

Deployrr exits. Start it again to continue.

Reset deletes Deployrr’s setup status, program and logs. It keeps your saved settings, such as the Docker folder, username, server IP, domain, Intro and Mode. Use it only when Refresh did not help.

The screen is titled Reset Deployrr Status. It warns that the operation deletes all user-supplied and status information, and that you will need to complete setup steps again. Reset keeps your app data, but it stops your apps.

After you press Y, you see four steps:

  1. 1/4 Stopping Docker services. This stops and removes your app containers.
  2. 2/4 Cleaning unused Docker data. This deletes every Docker image that no running container uses. Because your apps are now down, that means all of your app images. It also deletes every stopped container on the server, unused networks, build cache and unused volumes. A named volume that no container uses can be deleted too.
  3. 3/4 Resetting Deployrr configuration. This deletes Deployrr’s setup status, logs and the Deployrr program in /opt/deployrr. The one thing kept is the file with your saved settings: Docker folder, Backups Folder, username, server IP, domain, setup mode, license email, Intro, Mode and similar values.
  4. 4/4 Clearing cache files, then Reset complete. Please re-run Deployrr to continue.

Reset does not touch your Docker folder. Your .env file, compose files, app data, secrets and rules files stay. For what each of those files is, see Docker folder layout.

Containers you started outside Deployrr that are still running keep their images.

  1. Run Settings > Logs if you may need help later. Reset deletes Deployrr’s logs. See Generate a support log for the steps and Support on Discord for where to share it.
  2. Back up your Docker folder. See Back up and restore.
  3. Make sure you can wait for every app image to download again. Docker Hub limits can slow this. See Docker Hub rate limit.
  1. Open Settings.
  2. Select Reset.
  3. Read the warning.
  4. Type Y and press Enter to continue. Any other key goes back.
  5. Wait for Reset complete. Please re-run Deployrr to continue.
  1. Run the install command again. See Run the installer again for the command and Install errors if you see command not found.

  2. Start Deployrr and open Prerequisites. Your saved settings (Docker folder, username, server IP, domain, setup mode) are still set. Environment shows DONE again if your Docker folder is intact, so you don’t need to redo it. Redo Disclaimers, Packages, Build Cache and System Checks. In Hybrid mode, also redo Domain Checks (in Local mode it shows NOT-REQUIRED). Your license normally still works. If it shows as Free, run Prerequisites > Verify. See Prerequisites.

  3. System > Bash Aliases shows DONE again if the Deployrr block is still in ~/.bashrc and the alias file is still in your Docker folder.

  4. Bring your apps back. Tools > Stack Manager > Up works once every Prerequisite is DONE and needs a Basic, Plus or Pro license. See Stack Manager. Or, with the Bash aliases, run:

    Terminal window
    dcup

    Without the aliases, run this. Replace YOUR_DOCKER_FOLDER with the path to your Docker folder and HOSTNAME with your server’s hostname.

    Terminal window
    sudo docker compose --profile all -f YOUR_DOCKER_FOLDER/docker-compose-HOSTNAME.yml up -d

Docker downloads all app images again, so this can take a while.

To see how an alias brings a whole stack down and back up, watch Bash aliases: dc down and dc up at 8:43 (manual Docker Compose setup; Deployrr does these steps for you).

Remove uninstalls Deployrr. Your apps keep running.

The screen is titled Remove Deployrr. It warns that the operation permanently removes Deployrr from your system. It says:

  • Deployrr configuration files will be deleted.
  • Cache files will be cleared.
  • Deployrr scripts will be removed.
  • Docker containers will remain running.
  • Application data will not be deleted.
  1. Run Settings > Logs if you may need help later. Remove deletes Deployrr’s logs. See Generate a support log.
  2. Back up your Docker folder. See Back up and restore.
  3. Open Settings.
  4. Select Remove.
  5. Read the warning.
  6. Type Y and press Enter to continue. Any other key goes back.

You see 1/3 Removing Deployrr configuration, 2/3 Clearing cache files, 3/3 Removing Deployrr scripts, then Deployrr removal complete. Deployrr exits.

  • All app containers and images. Your apps keep running.
  • Your Docker folder, with compose files, .env, app data, secrets and Traefik rules.
  • The lines Deployrr added to ~/.bashrc and ~/.bash_profile. They sit in blocks marked Bash Aliases added by Deployrr and Sourcing .bashrc (added by Deployrr).
  • Possibly the /usr/local/bin/deployrr link, which now points to nothing. Check with ls -l /usr/local/bin/deployrr.
  • Docker itself and the packages Deployrr installed.
  • Mounts you added. To remove them, see SMB and NFS mounts or Rclone SMB setup.

You can still manage your apps with docker compose or the Bash aliases. To understand what these commands do, read UDMS part 13: Docker Compose commands and Bash aliases (manual setup).

Do this only if you want every trace gone.

  1. Stop your apps. Replace YOUR_DOCKER_FOLDER and HOSTNAME as in the earlier command.

    Terminal window
    sudo docker compose --profile all -f YOUR_DOCKER_FOLDER/docker-compose-HOSTNAME.yml down
  2. If the link is still there, delete it.

    Terminal window
    sudo rm /usr/local/bin/deployrr
  3. Open ~/.bashrc in a text editor and delete the lines Deployrr added.

  4. Open ~/.bash_profile and delete the lines Deployrr added.

  5. Delete the Docker folder only when your backup is safe and you no longer need the app data.

Run the install command again. Deployrr starts fresh, and you redo the Prerequisites.

  • After Refresh: Deployrr exited with Refresh complete. Start it again and the main menu opens.
  • After Reset: Reset complete appeared. After you reinstall and start Deployrr, your saved settings and Environment still show, and Disclaimers, Packages, Build Cache and System Checks show as not done (Domain Checks too, in Hybrid mode).
  • After Remove: Deployrr removal complete appeared. Running deployrr fails, and sudo docker ps still lists your apps.