The main goal of DockSTARTer is to make it quick and easy to get up and running with Docker.

You may choose to rely on DockSTARTer for various changes to your Docker system or use DockSTARTer as a stepping stone and learn to do more advanced configurations.

Getting Started

System Requirements

• You must be running a supported platform or an operating system based on a supported platform. Platforms named below will link to documentation listing compatible versions.
• You must be logged in as a non-root user with sudo permissions.

One Time Setup (required)

• APK Systems (Alpine)

  sudo apk add curl git
  bash -c "$(curl -fsSL https://get.dockstarter.com)"
  sudo reboot
  

• APT Systems (Debian, Ubuntu, etc)

  sudo apt-get install curl git
  bash -c "$(curl -fsSL https://get.dockstarter.com)"
  sudo reboot
  

  Raspbian requires a few extra commands

  sudo apt-get update
  sudo apt-get dist-upgrade
  sudo apt-get install curl git
  bash -c "$(curl -fsSL https://get.docker.com)"
  bash -c "$(curl -fsSL https://get.dockstarter.com)"
  sudo reboot
  

  OpenMediaVault (OMV) requires special instructions found here

• DNF Systems (Fedora)

  sudo dnf install curl git
  bash -c "$(curl -fsSL https://get.dockstarter.com)"
  sudo reboot
  

• Pacman Systems (Arch, Manjaro, EndeavourOS, etc.)

  sudo pacman -Sy curl docker git
  bash -c "$(curl -fsSL https://get.dockstarter.com)"
  sudo reboot
  

• YUM Systems (CentOS)

  sudo yum install curl git
  bash -c "$(curl -fsSL https://get.dockstarter.com)"
  sudo reboot
  

• MacOS Systems (Homebrew)

  brew update
  brew upgrade --cask
  brew upgrade
  brew install --cask docker
  brew install docker-compose
  

  or

  brew update
  brew upgrade --cask
  brew upgrade
  brew install docker docker-compose
  

  brew install bash curl git grep gnu-sed
  bash -c "$(curl -fsSL https://get.dockstarter.com)"
  sudo reboot
  

  Additional Steps for MacOS:

  • Run Docker at start up:
    • In docker desktop (Docker.app) open settings and ensure "Start Docker Desktop when you sign in to your computer" is enabled in the General heading. This step is required to to start docker automatically after a restart and allow DockSTARTer to communicate with the docker daemon.
  • Approve Docker keychain permissions:
    • At least once after installing DockSTARTer open the terminal.app from the MacOS desktop and run the DockSTARTer command ds -c. A keychain access dialog will pop up. Type your MacOS login password into the dialog and click on "Always Allow".

## NOTE: Run the appropriate command for your distro
sudo apt-get install curl git
sudo dnf install curl git
sudo pacman -Sy curl git
sudo yum install curl git
brew install bash curl git grep gnu-sed

git clone https://github.com/GhostWriters/DockSTARTer "/home/${USER}/.dockstarter"
bash /home/"${USER}"/.dockstarter/main.sh -vi
sudo reboot

Running DockSTARTer

ds

To run DockSTARTer, use the command above. You should now see the main menu from the screenshots. Select Configuration and then Full Setup, and you will be guided through selecting apps and starting containers.

See our documentation for more detailed information.

Support

Click the chat badge to join us on Discord for support!

Feature Request | Bug Report

Additional information can be found on our Support Page.

Contributing

Want to help develop DockSTARTer? Check out our contributing guidelines and code of conduct.

Contributors

This project exists thanks to all the people who contribute.

Supporters

Support the project by donating on Open Collective.

Backers

Thank you to all our backers! Become a backer.

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor.

Special Thanks

• SmartHomeBeginner.com for creating AtoMiC-ToolKit that served as this project's primary inspiration, and later this guide that provided some initial direction with Docker.
• LinuxServer.io for maintaining most Docker images used in this project.